Class: Azure::DataFactory::Mgmt::V2018_06_01::IntegrationRuntimes

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb

Overview

The Azure Data Factory V2 management API provides a RESTful set of web services that interact with Azure Data Factory V2 services.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ IntegrationRuntimes

Creates and initializes a new instance of the IntegrationRuntimes class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DataFactoryManagementClient (readonly)

Returns reference to the DataFactoryManagementClient.

Returns:



23
24
25
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 23

def client
  @client
end

Instance Method Details

#begin_start(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ IntegrationRuntimeStatusResponse

Starts a ManagedReserved type integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeStatusResponse) —

    operation results.



1681
1682
1683
1684
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1681

def begin_start(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = begin_start_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#begin_start_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

Starts a ManagedReserved type integration runtime.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1712

def begin_start_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/start'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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 || 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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeStatusResponse.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_start_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Starts a ManagedReserved type integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1697
1698
1699
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1697

def begin_start_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  begin_start_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
end

#begin_stop(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Object

Stops a ManagedReserved type integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that



1787
1788
1789
1790
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1787

def begin_stop(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = begin_stop_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  nil
end

#begin_stop_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

Stops a ManagedReserved type integration runtime.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1818

def begin_stop_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/stop'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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 || status_code == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#begin_stop_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Stops a ManagedReserved type integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1803
1804
1805
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1803

def begin_stop_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  begin_stop_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
end

#create_linked_integration_runtime(resource_group_name, factory_name, integration_runtime_name, create_linked_integration_runtime_request, custom_headers: nil) ⇒ IntegrationRuntimeStatusResponse

Create a linked integration runtime entry in a shared integration runtime.

CreateLinkedIntegrationRuntimeRequest

The linked integration runtime

properties. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeStatusResponse) —

    operation results.



1560
1561
1562
1563
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1560

def create_linked_integration_runtime(resource_group_name, factory_name, integration_runtime_name, create_linked_integration_runtime_request, custom_headers:nil)
  response = create_linked_integration_runtime_async(resource_group_name, factory_name, integration_runtime_name, create_linked_integration_runtime_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_linked_integration_runtime_async(resource_group_name, factory_name, integration_runtime_name, create_linked_integration_runtime_request, custom_headers: nil) ⇒ Concurrent::Promise

Create a linked integration runtime entry in a shared integration runtime.

CreateLinkedIntegrationRuntimeRequest

The linked integration runtime

properties. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1597

def create_linked_integration_runtime_async(resource_group_name, factory_name, integration_runtime_name, create_linked_integration_runtime_request, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'create_linked_integration_runtime_request is nil' if create_linked_integration_runtime_request.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::DataFactory::Mgmt::V2018_06_01::Models::CreateLinkedIntegrationRuntimeRequest.mapper()
  request_content = @client.serialize(request_mapper,  create_linked_integration_runtime_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/linkedIntegrationRuntime'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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
      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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeStatusResponse.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#create_linked_integration_runtime_with_http_info(resource_group_name, factory_name, integration_runtime_name, create_linked_integration_runtime_request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create a linked integration runtime entry in a shared integration runtime.

CreateLinkedIntegrationRuntimeRequest

The linked integration runtime

properties. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1579
1580
1581
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1579

def create_linked_integration_runtime_with_http_info(resource_group_name, factory_name, integration_runtime_name, create_linked_integration_runtime_request, custom_headers:nil)
  create_linked_integration_runtime_async(resource_group_name, factory_name, integration_runtime_name, create_linked_integration_runtime_request, custom_headers:custom_headers).value!
end

#create_or_update(resource_group_name, factory_name, integration_runtime_name, integration_runtime, if_match: nil, custom_headers: nil) ⇒ IntegrationRuntimeResource

Creates or updates an integration runtime.

resource definition. be specified for update, for which it should match existing entity or can be

  • for unconditional update.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

  • integration_runtime (IntegrationRuntimeResource) —

    Integration runtime

  • if_match (String) (defaults to: nil) —

    ETag of the integration runtime entity. Should only

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeResource) —

    operation results.



141
142
143
144
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 141

def create_or_update(resource_group_name, factory_name, integration_runtime_name, integration_runtime, if_match:nil, custom_headers:nil)
  response = create_or_update_async(resource_group_name, factory_name, integration_runtime_name, integration_runtime, if_match:if_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, factory_name, integration_runtime_name, integration_runtime, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates an integration runtime.

resource definition. be specified for update, for which it should match existing entity or can be

  • for unconditional update.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

  • integration_runtime (IntegrationRuntimeResource) —

    Integration runtime

  • if_match (String) (defaults to: nil) —

    ETag of the integration runtime entity. Should only

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 182

def create_or_update_async(resource_group_name, factory_name, integration_runtime_name, integration_runtime, if_match:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'integration_runtime is nil' if integration_runtime.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['If-Match'] = if_match unless if_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeResource.mapper()
  request_content = @client.serialize(request_mapper,  integration_runtime)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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
      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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeResource.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#create_or_update_with_http_info(resource_group_name, factory_name, integration_runtime_name, integration_runtime, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates an integration runtime.

resource definition. be specified for update, for which it should match existing entity or can be

  • for unconditional update.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

  • integration_runtime (IntegrationRuntimeResource) —

    Integration runtime

  • if_match (String) (defaults to: nil) —

    ETag of the integration runtime entity. Should only

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



162
163
164
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 162

def create_or_update_with_http_info(resource_group_name, factory_name, integration_runtime_name, integration_runtime, if_match:nil, custom_headers:nil)
  create_or_update_async(resource_group_name, factory_name, integration_runtime_name, integration_runtime, if_match:if_match, custom_headers:custom_headers).value!
end

#delete(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Object

Deletes an integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that



504
505
506
507
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 504

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

#delete_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes an integration runtime.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 535

def delete_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes an integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



520
521
522
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 520

def delete_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  delete_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, factory_name, integration_runtime_name, if_none_match: nil, custom_headers: nil) ⇒ IntegrationRuntimeResource

Gets an integration runtime.

only be specified for get. If the ETag matches the existing entity tag, or if

  • was provided, then no content will be returned.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

  • if_none_match (String) (defaults to: nil) —

    ETag of the integration runtime entity. Should

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeResource) —

    operation results.



270
271
272
273
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 270

def get(resource_group_name, factory_name, integration_runtime_name, if_none_match:nil, custom_headers:nil)
  response = get_async(resource_group_name, factory_name, integration_runtime_name, if_none_match:if_none_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, factory_name, integration_runtime_name, if_none_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets an integration runtime.

only be specified for get. If the ETag matches the existing entity tag, or if

  • was provided, then no content will be returned.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

  • if_none_match (String) (defaults to: nil) —

    ETag of the integration runtime entity. Should

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 307

def get_async(resource_group_name, factory_name, integration_runtime_name, if_none_match:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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['If-None-Match'] = if_none_match unless if_none_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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 || status_code == 304
      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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeResource.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_connection_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ IntegrationRuntimeConnectionInfo

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeConnectionInfo) —

    operation results.



709
710
711
712
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 709

def get_connection_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = get_connection_info_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_connection_info_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 742

def get_connection_info_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getConnectionInfo'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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 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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeConnectionInfo.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_connection_info_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the on-premises integration runtime connection information for encrypting the on-premises data source credentials.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



726
727
728
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 726

def get_connection_info_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  get_connection_info_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
end

#get_monitoring_data(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ IntegrationRuntimeMonitoringData

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeMonitoringData) —

    operation results.



1239
1240
1241
1242
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1239

def get_monitoring_data(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = get_monitoring_data_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_monitoring_data_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1272
1273
1274
1275
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
1335
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1272

def get_monitoring_data_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/monitoringData'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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 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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeMonitoringData.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_monitoring_data_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get the integration runtime monitoring data, which includes the monitor data for all the nodes under this integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1256
1257
1258
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1256

def get_monitoring_data_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  get_monitoring_data_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
end

#get_status(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ IntegrationRuntimeStatusResponse

Gets detailed status information for an integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeStatusResponse) —

    operation results.



601
602
603
604
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 601

def get_status(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = get_status_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_status_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets detailed status information for an integration runtime.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 632

def get_status_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getStatus'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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 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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeStatusResponse.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_status_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets detailed status information for an integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



617
618
619
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 617

def get_status_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  get_status_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
end

#get_with_http_info(resource_group_name, factory_name, integration_runtime_name, if_none_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets an integration runtime.

only be specified for get. If the ETag matches the existing entity tag, or if

  • was provided, then no content will be returned.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

  • if_none_match (String) (defaults to: nil) —

    ETag of the integration runtime entity. Should

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



289
290
291
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 289

def get_with_http_info(resource_group_name, factory_name, integration_runtime_name, if_none_match:nil, custom_headers:nil)
  get_async(resource_group_name, factory_name, integration_runtime_name, if_none_match:if_none_match, custom_headers:custom_headers).value!
end

#list_auth_keys(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ IntegrationRuntimeAuthKeys

Retrieves the authentication keys for an integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeAuthKeys) —

    operation results.



939
940
941
942
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 939

def list_auth_keys(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = list_auth_keys_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_auth_keys_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieves the authentication keys for an integration runtime.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 970

def list_auth_keys_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/listAuthKeys'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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 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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeAuthKeys.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_auth_keys_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieves the authentication keys for an integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



955
956
957
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 955

def list_auth_keys_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  list_auth_keys_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
end

#list_by_factory(resource_group_name, factory_name, custom_headers: nil) ⇒ Array<IntegrationRuntimeResource>

Lists integration runtimes.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

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

    A hash of custom headers that

Returns:

  • (Array<IntegrationRuntimeResource>) —

    operation results.



35
36
37
38
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 35

def list_by_factory(resource_group_name, factory_name, custom_headers:nil)
  first_page = list_by_factory_as_lazy(resource_group_name, factory_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_factory_as_lazy(resource_group_name, factory_name, custom_headers: nil) ⇒ IntegrationRuntimeListResponse

Lists integration runtimes.

will be added to the HTTP request.

of the response.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeListResponse) —

    which provide lazy access to pages



1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1974

def list_by_factory_as_lazy(resource_group_name, factory_name, custom_headers:nil)
  response = list_by_factory_async(resource_group_name, factory_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_factory_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_factory_async(resource_group_name, factory_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists integration runtimes.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 64

def list_by_factory_async(resource_group_name, factory_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes'

  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,'factoryName' => factory_name},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeListResponse.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_factory_next(next_page_link, custom_headers: nil) ⇒ IntegrationRuntimeListResponse

Lists integration runtimes.

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:

  • (IntegrationRuntimeListResponse) —

    operation results.



1883
1884
1885
1886
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1883

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

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

Lists integration runtimes.

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.



1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1912

def list_by_factory_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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeListResponse.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_factory_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists integration runtimes.

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.



1898
1899
1900
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1898

def list_by_factory_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_factory_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_factory_with_http_info(resource_group_name, factory_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists integration runtimes.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



50
51
52
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 50

def list_by_factory_with_http_info(resource_group_name, factory_name, custom_headers:nil)
  list_by_factory_async(resource_group_name, factory_name, custom_headers:custom_headers).value!
end

#regenerate_auth_key(resource_group_name, factory_name, integration_runtime_name, regenerate_key_parameters, custom_headers: nil) ⇒ IntegrationRuntimeAuthKeys

Regenerates the authentication key for an integration runtime.

The parameters for regenerating integration runtime authentication key. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeAuthKeys) —

    operation results.



820
821
822
823
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 820

def regenerate_auth_key(resource_group_name, factory_name, integration_runtime_name, regenerate_key_parameters, custom_headers:nil)
  response = regenerate_auth_key_async(resource_group_name, factory_name, integration_runtime_name, regenerate_key_parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#regenerate_auth_key_async(resource_group_name, factory_name, integration_runtime_name, regenerate_key_parameters, custom_headers: nil) ⇒ Concurrent::Promise

Regenerates the authentication key for an integration runtime.

The parameters for regenerating integration runtime authentication key. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 855

def regenerate_auth_key_async(resource_group_name, factory_name, integration_runtime_name, regenerate_key_parameters, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'regenerate_key_parameters is nil' if regenerate_key_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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeRegenerateKeyParameters.mapper()
  request_content = @client.serialize(request_mapper,  regenerate_key_parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/regenerateAuthKey'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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
      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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeAuthKeys.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

#regenerate_auth_key_with_http_info(resource_group_name, factory_name, integration_runtime_name, regenerate_key_parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Regenerates the authentication key for an integration runtime.

The parameters for regenerating integration runtime authentication key. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



838
839
840
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 838

def regenerate_auth_key_with_http_info(resource_group_name, factory_name, integration_runtime_name, regenerate_key_parameters, custom_headers:nil)
  regenerate_auth_key_async(resource_group_name, factory_name, integration_runtime_name, regenerate_key_parameters, custom_headers:custom_headers).value!
end

#remove_links(resource_group_name, factory_name, integration_runtime_name, linked_integration_runtime_request, custom_headers: nil) ⇒ Object

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

The data factory name for the linked integration runtime. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that



1446
1447
1448
1449
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1446

def remove_links(resource_group_name, factory_name, integration_runtime_name, linked_integration_runtime_request, custom_headers:nil)
  response = remove_links_async(resource_group_name, factory_name, integration_runtime_name, linked_integration_runtime_request, custom_headers:custom_headers).value!
  nil
end

#remove_links_async(resource_group_name, factory_name, integration_runtime_name, linked_integration_runtime_request, custom_headers: nil) ⇒ Concurrent::Promise

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

The data factory name for the linked integration runtime. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1483

def remove_links_async(resource_group_name, factory_name, integration_runtime_name, linked_integration_runtime_request, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'linked_integration_runtime_request is nil' if linked_integration_runtime_request.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::DataFactory::Mgmt::V2018_06_01::Models::LinkedIntegrationRuntimeRequest.mapper()
  request_content = @client.serialize(request_mapper,  linked_integration_runtime_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/removeLinks'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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
      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

#remove_links_with_http_info(resource_group_name, factory_name, integration_runtime_name, linked_integration_runtime_request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Remove all linked integration runtimes under specific data factory in a self-hosted integration runtime.

The data factory name for the linked integration runtime. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1465
1466
1467
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1465

def remove_links_with_http_info(resource_group_name, factory_name, integration_runtime_name, linked_integration_runtime_request, custom_headers:nil)
  remove_links_async(resource_group_name, factory_name, integration_runtime_name, linked_integration_runtime_request, custom_headers:custom_headers).value!
end

#start(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ IntegrationRuntimeStatusResponse

Starts a ManagedReserved type integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeStatusResponse) —

    operation results.



1046
1047
1048
1049
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1046

def start(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = start_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#start_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1061

def start_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  # Send request
  promise = begin_start_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers)

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

#stop(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Object

Stops a ManagedReserved type integration runtime.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that



1088
1089
1090
1091
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1088

def stop(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = stop_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  nil
end

#stop_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1103

def stop_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  # Send request
  promise = begin_stop_async(resource_group_name, factory_name, integration_runtime_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

#sync_credentials(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Object

Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that



1133
1134
1135
1136
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1133

def sync_credentials(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = sync_credentials_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  nil
end

#sync_credentials_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
1222
1223
1224
1225
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1172

def sync_credentials_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/syncCredentials'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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 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

#sync_credentials_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Force the integration runtime to synchronize credentials across integration runtime nodes, and this will override the credentials across all worker nodes with those available on the dispatcher node. If you already have the latest credential backup file, you should manually import it (preferred) on any self-hosted integration runtime node than using this API directly.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1153
1154
1155
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1153

def sync_credentials_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  sync_credentials_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
end

#update(resource_group_name, factory_name, integration_runtime_name, update_integration_runtime_request, custom_headers: nil) ⇒ IntegrationRuntimeResource

Updates an integration runtime.

The parameters for updating an integration runtime. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (IntegrationRuntimeResource) —

    operation results.



386
387
388
389
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 386

def update(resource_group_name, factory_name, integration_runtime_name, update_integration_runtime_request, custom_headers:nil)
  response = update_async(resource_group_name, factory_name, integration_runtime_name, update_integration_runtime_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, factory_name, integration_runtime_name, update_integration_runtime_request, custom_headers: nil) ⇒ Concurrent::Promise

Updates an integration runtime.

The parameters for updating an integration runtime. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 421

def update_async(resource_group_name, factory_name, integration_runtime_name, update_integration_runtime_request, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'update_integration_runtime_request is nil' if update_integration_runtime_request.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::DataFactory::Mgmt::V2018_06_01::Models::UpdateIntegrationRuntimeRequest.mapper()
  request_content = @client.serialize(request_mapper,  update_integration_runtime_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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(:patch, 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::DataFactory::Mgmt::V2018_06_01::Models::IntegrationRuntimeResource.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

#update_with_http_info(resource_group_name, factory_name, integration_runtime_name, update_integration_runtime_request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates an integration runtime.

The parameters for updating an integration runtime. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



404
405
406
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 404

def update_with_http_info(resource_group_name, factory_name, integration_runtime_name, update_integration_runtime_request, custom_headers:nil)
  update_async(resource_group_name, factory_name, integration_runtime_name, update_integration_runtime_request, custom_headers:custom_headers).value!
end

#upgrade(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Object

Upgrade self-hosted integration runtime to latest version if availability.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that



1347
1348
1349
1350
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1347

def upgrade(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  response = upgrade_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
  nil
end

#upgrade_async(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ Concurrent::Promise

Upgrade self-hosted integration runtime to latest version if availability.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1378

def upgrade_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'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, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'integration_runtime_name is nil' if integration_runtime_name.nil?
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MaxLength': '63'" if !integration_runtime_name.nil? && integration_runtime_name.length > 63
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'MinLength': '3'" if !integration_runtime_name.nil? && integration_runtime_name.length < 3
  fail ArgumentError, "'integration_runtime_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !integration_runtime_name.nil? && integration_runtime_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/upgrade'

  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,'factoryName' => factory_name,'integrationRuntimeName' => integration_runtime_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 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

#upgrade_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Upgrade self-hosted integration runtime to latest version if availability.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • integration_runtime_name (String) —

    The integration runtime name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1363
1364
1365
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/integration_runtimes.rb', line 1363

def upgrade_with_http_info(resource_group_name, factory_name, integration_runtime_name, custom_headers:nil)
  upgrade_async(resource_group_name, factory_name, integration_runtime_name, custom_headers:custom_headers).value!
end