Class: Azure::DataFactory::Mgmt::V2018_06_01::ExposureControl

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01/generated/azure_mgmt_data_factory/exposure_control.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) ⇒ ExposureControl

Creates and initializes a new instance of the ExposureControl class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/exposure_control.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/exposure_control.rb', line 23

def client
  @client
end

Instance Method Details

#get_feature_value(location_id, exposure_control_request, custom_headers: nil) ⇒ ExposureControlResponse

Get exposure control feature for specific location.

request. will be added to the HTTP request.

Parameters:

  • location_id (String) —

    The location identifier.

  • exposure_control_request (ExposureControlRequest) —

    The exposure control

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

    A hash of custom headers that

Returns:

  • (ExposureControlResponse) —

    operation results.



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

def get_feature_value(location_id, exposure_control_request, custom_headers:nil)
  response = get_feature_value_async(location_id, exposure_control_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_feature_value_async(location_id, exposure_control_request, custom_headers: nil) ⇒ Concurrent::Promise

Get exposure control feature for specific location.

request. to the HTTP request.

Parameters:

  • location_id (String) —

    The location identifier.

  • exposure_control_request (ExposureControlRequest) —

    The exposure control

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
124
125
126
127
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/exposure_control.rb', line 67

def get_feature_value_async(location_id, exposure_control_request, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'location_id is nil' if location_id.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'exposure_control_request is nil' if exposure_control_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::ExposureControlRequest.mapper()
  request_content = @client.serialize(request_mapper,  exposure_control_request)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/providers/Microsoft.DataFactory/locations/{locationId}/getFeatureValue'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'locationId' => location_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      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::ExposureControlResponse.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_feature_value_by_factory(resource_group_name, factory_name, exposure_control_request, custom_headers: nil) ⇒ ExposureControlResponse

Get exposure control feature for specific factory.

request. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • exposure_control_request (ExposureControlRequest) —

    The exposure control

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

    A hash of custom headers that

Returns:

  • (ExposureControlResponse) —

    operation results.



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

def get_feature_value_by_factory(resource_group_name, factory_name, exposure_control_request, custom_headers:nil)
  response = get_feature_value_by_factory_async(resource_group_name, factory_name, exposure_control_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Get exposure control feature for specific factory.

request. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • exposure_control_request (ExposureControlRequest) —

    The exposure control

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



174
175
176
177
178
179
180
181
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
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/exposure_control.rb', line 174

def get_feature_value_by_factory_async(resource_group_name, factory_name, exposure_control_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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'exposure_control_request is nil' if exposure_control_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::ExposureControlRequest.mapper()
  request_content = @client.serialize(request_mapper,  exposure_control_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}/getFeatureValue'

  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},
      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::ExposureControlResponse.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_feature_value_by_factory_with_http_info(resource_group_name, factory_name, exposure_control_request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get exposure control feature for specific factory.

request. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • exposure_control_request (ExposureControlRequest) —

    The exposure control

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



158
159
160
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/exposure_control.rb', line 158

def get_feature_value_by_factory_with_http_info(resource_group_name, factory_name, exposure_control_request, custom_headers:nil)
  get_feature_value_by_factory_async(resource_group_name, factory_name, exposure_control_request, custom_headers:custom_headers).value!
end

#get_feature_value_with_http_info(location_id, exposure_control_request, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get exposure control feature for specific location.

request. will be added to the HTTP request.

Parameters:

  • location_id (String) —

    The location identifier.

  • exposure_control_request (ExposureControlRequest) —

    The exposure control

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



52
53
54
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/exposure_control.rb', line 52

def get_feature_value_with_http_info(location_id, exposure_control_request, custom_headers:nil)
  get_feature_value_async(location_id, exposure_control_request, custom_headers:custom_headers).value!
end

#query_feature_values_by_factory(resource_group_name, factory_name, exposure_control_batch_request, custom_headers: nil) ⇒ ExposureControlBatchResponse

Get list of exposure control features for specific factory.

exposure control request for list of features. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • exposure_control_batch_request (ExposureControlBatchRequest) —

    The

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

    A hash of custom headers that

Returns:

  • (ExposureControlBatchResponse) —

    operation results.



255
256
257
258
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/exposure_control.rb', line 255

def query_feature_values_by_factory(resource_group_name, factory_name, exposure_control_batch_request, custom_headers:nil)
  response = query_feature_values_by_factory_async(resource_group_name, factory_name, exposure_control_batch_request, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Get list of exposure control features for specific factory.

exposure control request for list of features. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • exposure_control_batch_request (ExposureControlBatchRequest) —

    The

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/exposure_control.rb', line 288

def query_feature_values_by_factory_async(resource_group_name, factory_name, exposure_control_batch_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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'exposure_control_batch_request is nil' if exposure_control_batch_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::ExposureControlBatchRequest.mapper()
  request_content = @client.serialize(request_mapper,  exposure_control_batch_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}/queryFeaturesValue'

  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},
      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::ExposureControlBatchResponse.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

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

Get list of exposure control features for specific factory.

exposure control request for list of features. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • exposure_control_batch_request (ExposureControlBatchRequest) —

    The

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



272
273
274
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/exposure_control.rb', line 272

def query_feature_values_by_factory_with_http_info(resource_group_name, factory_name, exposure_control_batch_request, custom_headers:nil)
  query_feature_values_by_factory_async(resource_group_name, factory_name, exposure_control_batch_request, custom_headers:custom_headers).value!
end