Class: Azure::CustomerInsights::Mgmt::V2017_01_01::ConnectorMappings

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb

Overview

The Azure Customer Insights management API provides a RESTful set of web services that interact with Azure Customer Insights service to manage your resources. The API has entities that capture the relationship between an end user and the Azure Customer Insights service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ConnectorMappings

Creates and initializes a new instance of the ConnectorMappings class.



20
21
22
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CustomerInsightsManagementClient (readonly) 



25
26
27
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 25

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, hub_name, connector_name, mapping_name, parameters, custom_headers: nil) ⇒ ConnectorMappingResourceFormat

Creates a connector mapping or updates an existing connector mapping in the connector.

CreateOrUpdate Connector Mapping operation. will be added to the HTTP request.



42
43
44
45
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 42

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

#create_or_update_async(resource_group_name, hub_name, connector_name, mapping_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Creates a connector mapping or updates an existing connector mapping in the connector.

CreateOrUpdate Connector Mapping operation. to the HTTP request.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 81

def create_or_update_async(resource_group_name, hub_name, connector_name, mapping_name, parameters, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'connector_name is nil' if connector_name.nil?
  fail ArgumentError, 'mapping_name is nil' if mapping_name.nil?
  fail ArgumentError, "'mapping_name' should satisfy the constraint - 'MaxLength': '128'" if !mapping_name.nil? && mapping_name.length > 128
  fail ArgumentError, "'mapping_name' should satisfy the constraint - 'MinLength': '1'" if !mapping_name.nil? && mapping_name.length < 1
  fail ArgumentError, "'mapping_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z][a-zA-Z0-9_]+$'" if !mapping_name.nil? && mapping_name.match(Regexp.new('^^[a-zA-Z][a-zA-Z0-9_]+$$')).nil?
  fail ArgumentError, 'parameters is nil' if parameters.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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::CustomerInsights::Mgmt::V2017_01_01::Models::ConnectorMappingResourceFormat.mapper()
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings/{mappingName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'connectorName' => connector_name,'mappingName' => mapping_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::ConnectorMappingResourceFormat.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::ConnectorMappingResourceFormat.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, hub_name, connector_name, mapping_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a connector mapping or updates an existing connector mapping in the connector.

CreateOrUpdate Connector Mapping operation. will be added to the HTTP request.



62
63
64
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 62

def create_or_update_with_http_info(resource_group_name, hub_name, connector_name, mapping_name, parameters, custom_headers:nil)
  create_or_update_async(resource_group_name, hub_name, connector_name, mapping_name, parameters, custom_headers:custom_headers).value!
end

#delete(resource_group_name, hub_name, connector_name, mapping_name, custom_headers: nil) ⇒ Object

Deletes a connector mapping in the connector.

will be added to the HTTP request.



268
269
270
271
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 268

def delete(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:nil)
  response = delete_async(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, hub_name, connector_name, mapping_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a connector mapping in the connector.

to the HTTP request.



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 301

def delete_async(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'connector_name is nil' if connector_name.nil?
  fail ArgumentError, 'mapping_name is nil' if mapping_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings/{mappingName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'connectorName' => connector_name,'mappingName' => mapping_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 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
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, hub_name, connector_name, mapping_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a connector mapping in the connector.

will be added to the HTTP request.



285
286
287
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 285

def delete_with_http_info(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:nil)
  delete_async(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, hub_name, connector_name, mapping_name, custom_headers: nil) ⇒ ConnectorMappingResourceFormat

Gets a connector mapping in the connector.

will be added to the HTTP request.



169
170
171
172
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 169

def get(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:nil)
  response = get_async(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, hub_name, connector_name, mapping_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets a connector mapping in the connector.

to the HTTP request.



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
255
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 202

def get_async(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'connector_name is nil' if connector_name.nil?
  fail ArgumentError, 'mapping_name is nil' if mapping_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings/{mappingName}'

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::ConnectorMappingResourceFormat.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(resource_group_name, hub_name, connector_name, mapping_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a connector mapping in the connector.

will be added to the HTTP request.



186
187
188
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 186

def get_with_http_info(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:nil)
  get_async(resource_group_name, hub_name, connector_name, mapping_name, custom_headers:custom_headers).value!
end

#list_by_connector(resource_group_name, hub_name, connector_name, custom_headers: nil) ⇒ Array<ConnectorMappingResourceFormat>

Gets all the connector mappings in the specified connector.

will be added to the HTTP request.



357
358
359
360
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 357

def list_by_connector(resource_group_name, hub_name, connector_name, custom_headers:nil)
  first_page = list_by_connector_as_lazy(resource_group_name, hub_name, connector_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_connector_as_lazy(resource_group_name, hub_name, connector_name, custom_headers: nil) ⇒ ConnectorMappingListResult

Gets all the connector mappings in the specified connector.

will be added to the HTTP request.

the response.



542
543
544
545
546
547
548
549
550
551
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 542

def list_by_connector_as_lazy(resource_group_name, hub_name, connector_name, custom_headers:nil)
  response = list_by_connector_async(resource_group_name, hub_name, connector_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_connector_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_connector_async(resource_group_name, hub_name, connector_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets all the connector mappings in the specified connector.

to the HTTP request.



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 388

def list_by_connector_async(resource_group_name, hub_name, connector_name, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, 'hub_name is nil' if hub_name.nil?
  fail ArgumentError, 'connector_name is nil' if connector_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.CustomerInsights/hubs/{hubName}/connectors/{connectorName}/mappings'

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::ConnectorMappingListResult.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_connector_next(next_page_link, custom_headers: nil) ⇒ ConnectorMappingListResult

Gets all the connector mappings in the specified connector.

to List operation. will be added to the HTTP request.



452
453
454
455
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 452

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

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

Gets all the connector mappings in the specified connector.

to List operation. to the HTTP request.



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 481

def list_by_connector_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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::CustomerInsights::Mgmt::V2017_01_01::Models::ConnectorMappingListResult.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_connector_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the connector mappings in the specified connector.

to List operation. will be added to the HTTP request.



467
468
469
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 467

def list_by_connector_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_connector_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_connector_with_http_info(resource_group_name, hub_name, connector_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all the connector mappings in the specified connector.

will be added to the HTTP request.



373
374
375
 
# File 'lib/2017-01-01/generated/azure_mgmt_customer_insights/connector_mappings.rb', line 373

def list_by_connector_with_http_info(resource_group_name, hub_name, connector_name, custom_headers:nil)
  list_by_connector_async(resource_group_name, hub_name, connector_name, custom_headers:custom_headers).value!
end