Class: Azure::ARM::CustomerInsights::Profiles

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/generated/azure_mgmt_customer_insights/profiles.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) ⇒ Profiles

Creates and initializes a new instance of the Profiles class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ CustomerInsightsManagementClient (readonly)

Returns reference to the CustomerInsightsManagementClient.

Returns:



25
26
27
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 25

def client
  @client
end

Instance Method Details

#begin_create_or_update(resource_group_name, hub_name, profile_name, parameters, custom_headers = nil) ⇒ ProfileResourceFormat

Creates a profile within a Hub, or updates an existing profile.

create/delete Profile type operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • parameters (ProfileResourceFormat) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (ProfileResourceFormat) —

    operation results.



437
438
439
440
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 437

def begin_create_or_update(resource_group_name, hub_name, profile_name, parameters, custom_headers = nil)
  response = begin_create_or_update_async(resource_group_name, hub_name, profile_name, parameters, custom_headers).value!
  response.body unless response.nil?
end

#begin_create_or_update_async(resource_group_name, hub_name, profile_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

Creates a profile within a Hub, or updates an existing profile.

create/delete Profile type operation to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • parameters (ProfileResourceFormat) —

    Parameters supplied to the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



472
473
474
475
476
477
478
479
480
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
529
530
531
532
533
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 472

def begin_create_or_update_async(resource_group_name, hub_name, profile_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, 'profile_name is nil' if profile_name.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 = {}

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

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

  # Serialize Request
  request_mapper = Azure::ARM::CustomerInsights::Models::ProfileResourceFormat.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}/profiles/{profileName}'

  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,'profileName' => profile_name,'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 202
      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::ARM::CustomerInsights::Models::ProfileResourceFormat.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#begin_create_or_update_with_http_info(resource_group_name, hub_name, profile_name, parameters, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a profile within a Hub, or updates an existing profile.

create/delete Profile type operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • parameters (ProfileResourceFormat) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



455
456
457
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 455

def begin_create_or_update_with_http_info(resource_group_name, hub_name, profile_name, parameters, custom_headers = nil)
  begin_create_or_update_async(resource_group_name, hub_name, profile_name, parameters, custom_headers).value!
end

#begin_delete(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil) ⇒ Object

Deletes a profile within a hub

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    A hash of custom headers that



546
547
548
549
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 546

def begin_delete(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil)
  response = begin_delete_async(resource_group_name, hub_name, profile_name, locale_code, custom_headers).value!
  nil
end

#begin_delete_async(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil) ⇒ Concurrent::Promise

Deletes a profile within a hub

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 579

def begin_delete_async(resource_group_name, hub_name, profile_name, locale_code = 'en-us', 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, 'profile_name is nil' if profile_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 = {}

  # 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}/profiles/{profileName}'

  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,'profileName' => profile_name,'subscriptionId' => @client.subscription_id},
      query_params: {'locale-code' => locale_code,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

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

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

    result
  end

  promise.execute
end

#begin_delete_with_http_info(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a profile within a hub

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



563
564
565
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 563

def begin_delete_with_http_info(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil)
  begin_delete_async(resource_group_name, hub_name, profile_name, locale_code, custom_headers).value!
end

#create_or_update(resource_group_name, hub_name, profile_name, parameters, custom_headers = nil) ⇒ ProfileResourceFormat

Creates a profile within a Hub, or updates an existing profile.

create/delete Profile type operation will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • parameters (ProfileResourceFormat) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (ProfileResourceFormat) —

    operation results.



40
41
42
43
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 40

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

#create_or_update_async(resource_group_name, hub_name, profile_name, parameters, custom_headers = nil) ⇒ Concurrent::Promise

create/delete Profile type operation will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • parameters (ProfileResourceFormat) —

    Parameters supplied to the

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 57

def create_or_update_async(resource_group_name, hub_name, profile_name, parameters, custom_headers = nil)
  # Send request
  promise = begin_create_or_update_async(resource_group_name, hub_name, profile_name, parameters, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
      result_mapper = Azure::ARM::CustomerInsights::Models::ProfileResourceFormat.mapper()
      parsed_response = @client.deserialize(result_mapper, parsed_response)
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#delete(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil) ⇒ Object

Deletes a profile within a hub

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    A hash of custom headers that



183
184
185
186
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 183

def delete(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil)
  response = delete_async(resource_group_name, hub_name, profile_name, locale_code, custom_headers).value!
  nil
end

#delete_async(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil) ⇒ Concurrent::Promise

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    A hash of custom headers that

Returns:

  • (Concurrent::Promise) —

    promise which provides async access to http



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 199

def delete_async(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil)
  # Send request
  promise = begin_delete_async(resource_group_name, hub_name, profile_name, locale_code, custom_headers)

  promise = promise.then do |response|
    # Defining deserialization method.
    deserialize_method = lambda do |parsed_response|
    end

    # Waiting for response.
    @client.get_long_running_operation_result(response, deserialize_method)
  end

  promise
end

#get(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil) ⇒ ProfileResourceFormat

Gets information about the specified profile.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    A hash of custom headers that

Returns:

  • (ProfileResourceFormat) —

    operation results.



87
88
89
90
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 87

def get(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil)
  response = get_async(resource_group_name, hub_name, profile_name, locale_code, custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil) ⇒ Concurrent::Promise

Gets information about the specified profile.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 120

def get_async(resource_group_name, hub_name, profile_name, locale_code = 'en-us', 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, 'profile_name is nil' if profile_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 = {}

  # 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}/profiles/{profileName}'

  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,'profileName' => profile_name,'subscriptionId' => @client.subscription_id},
      query_params: {'locale-code' => locale_code,'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::ARM::CustomerInsights::Models::ProfileResourceFormat.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_enriching_kpis(resource_group_name, hub_name, profile_name, custom_headers = nil) ⇒ Array

Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

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

    A hash of custom headers that

Returns:

  • (Array) —

    operation results.



322
323
324
325
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 322

def get_enriching_kpis(resource_group_name, hub_name, profile_name, custom_headers = nil)
  response = get_enriching_kpis_async(resource_group_name, hub_name, profile_name, custom_headers).value!
  response.body unless response.nil?
end

#get_enriching_kpis_async(resource_group_name, hub_name, profile_name, custom_headers = nil) ⇒ Concurrent::Promise

Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
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
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 357

def get_enriching_kpis_async(resource_group_name, hub_name, profile_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, 'profile_name is nil' if profile_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 = {}

  # 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}/profiles/{profileName}/getEnrichingKpis'

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

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      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 = {
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'Sequence',
            element: {
                required: false,
                serialized_name: 'KpiDefinitionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'KpiDefinition'
                }
            }
          }
        }
        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_enriching_kpis_with_http_info(resource_group_name, hub_name, profile_name, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



340
341
342
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 340

def get_enriching_kpis_with_http_info(resource_group_name, hub_name, profile_name, custom_headers = nil)
  get_enriching_kpis_async(resource_group_name, hub_name, profile_name, custom_headers).value!
end

#get_with_http_info(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets information about the specified profile.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • profile_name (String) —

    The name of the profile.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



104
105
106
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 104

def get_with_http_info(resource_group_name, hub_name, profile_name, locale_code = 'en-us', custom_headers = nil)
  get_async(resource_group_name, hub_name, profile_name, locale_code, custom_headers).value!
end

#list_by_hub(resource_group_name, hub_name, locale_code = 'en-us', custom_headers = nil) ⇒ Array<ProfileResourceFormat>

Gets all profile in the hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    A hash of custom headers that

Returns:

  • (Array<ProfileResourceFormat>) —

    operation results.



226
227
228
229
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 226

def list_by_hub(resource_group_name, hub_name, locale_code = 'en-us', custom_headers = nil)
  first_page = list_by_hub_as_lazy(resource_group_name, hub_name, locale_code, custom_headers)
  first_page.get_all_items
end

#list_by_hub_as_lazy(resource_group_name, hub_name, locale_code = 'en-us', custom_headers = nil) ⇒ ProfileListResult

Gets all profile in the hub.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    A hash of custom headers that

Returns:

  • (ProfileListResult) —

    which provide lazy access to pages of the



721
722
723
724
725
726
727
728
729
730
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 721

def list_by_hub_as_lazy(resource_group_name, hub_name, locale_code = 'en-us', custom_headers = nil)
  response = list_by_hub_async(resource_group_name, hub_name, locale_code, custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_hub_next_async(next_page_link, custom_headers)
    end
    page
  end
end

#list_by_hub_async(resource_group_name, hub_name, locale_code = 'en-us', custom_headers = nil) ⇒ Concurrent::Promise

Gets all profile in the hub.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 257

def list_by_hub_async(resource_group_name, hub_name, locale_code = 'en-us', 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, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?


  request_headers = {}

  # 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}/profiles'

  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,'subscriptionId' => @client.subscription_id},
      query_params: {'locale-code' => locale_code,'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::ARM::CustomerInsights::Models::ProfileListResult.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_hub_next(next_page_link, custom_headers = nil) ⇒ ProfileListResult

Gets all profile in the hub.

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:

  • (ProfileListResult) —

    operation results.



632
633
634
635
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 632

def list_by_hub_next(next_page_link, custom_headers = nil)
  response = list_by_hub_next_async(next_page_link, custom_headers).value!
  response.body unless response.nil?
end

#list_by_hub_next_async(next_page_link, custom_headers = nil) ⇒ Concurrent::Promise

Gets all profile in the hub.

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.



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
696
697
698
699
700
701
702
703
704
705
706
707
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 661

def list_by_hub_next_async(next_page_link, custom_headers = nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.nil?


  request_headers = {}

  # 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::ARM::CustomerInsights::Models::ProfileListResult.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_hub_next_with_http_info(next_page_link, custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all profile in the hub.

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.



647
648
649
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 647

def list_by_hub_next_with_http_info(next_page_link, custom_headers = nil)
  list_by_hub_next_async(next_page_link, custom_headers).value!
end

#list_by_hub_with_http_info(resource_group_name, hub_name, locale_code = 'en-us', custom_headers = nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all profile in the hub.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group.

  • hub_name (String) —

    The name of the hub.

  • locale_code (String) (defaults to: 'en-us') —

    Locale of profile to retrieve, default is en-us.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



242
243
244
 
# File 'lib/generated/azure_mgmt_customer_insights/profiles.rb', line 242

def list_by_hub_with_http_info(resource_group_name, hub_name, locale_code = 'en-us', custom_headers = nil)
  list_by_hub_async(resource_group_name, hub_name, locale_code, custom_headers).value!
end