Class: Azure::CustomerInsights::Mgmt::V2017_04_26::Links
- Inherits:
-
Object
- Object
- Azure::CustomerInsights::Mgmt::V2017_04_26::Links
- Includes:
- MsRestAzure
- Defined in:
- lib/2017-04-26/generated/azure_mgmt_customer_insights/links.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
-
#client ⇒ CustomerInsightsManagementClient
readonly
Reference to the CustomerInsightsManagementClient.
Instance Method Summary collapse
-
#begin_create_or_update(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ LinkResourceFormat
Creates a link or updates an existing link in the hub.
-
#begin_create_or_update_async(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates a link or updates an existing link in the hub.
-
#begin_create_or_update_with_http_info(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates a link or updates an existing link in the hub.
-
#create_or_update(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ LinkResourceFormat
Creates a link or updates an existing link in the hub.
-
#create_or_update_async(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
CreateOrUpdate Link operation.
-
#delete(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ Object
Deletes a link in the hub.
-
#delete_async(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ Concurrent::Promise
Deletes a link in the hub.
-
#delete_with_http_info(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a link in the hub.
-
#get(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ LinkResourceFormat
Gets a link in the hub.
-
#get_async(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets a link in the hub.
-
#get_with_http_info(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets a link in the hub.
-
#initialize(client) ⇒ Links
constructor
Creates and initializes a new instance of the Links class.
-
#list_by_hub(resource_group_name, hub_name, custom_headers: nil) ⇒ Array<LinkResourceFormat>
Gets all the links in the specified hub.
-
#list_by_hub_as_lazy(resource_group_name, hub_name, custom_headers: nil) ⇒ LinkListResult
Gets all the links in the specified hub.
-
#list_by_hub_async(resource_group_name, hub_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets all the links in the specified hub.
-
#list_by_hub_next(next_page_link, custom_headers: nil) ⇒ LinkListResult
Gets all the links in the specified hub.
-
#list_by_hub_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Gets all the links in the specified hub.
-
#list_by_hub_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets all the links in the specified hub.
-
#list_by_hub_with_http_info(resource_group_name, hub_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets all the links in the specified hub.
Constructor Details
#initialize(client) ⇒ Links
Creates and initializes a new instance of the Links class.
20 21 22 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 20 def initialize(client) @client = client end |
Instance Attribute Details
#client ⇒ CustomerInsightsManagementClient (readonly)
Returns reference to the CustomerInsightsManagementClient.
25 26 27 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 25 def client @client end |
Instance Method Details
#begin_create_or_update(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ LinkResourceFormat
Creates a link or updates an existing link in the hub.
CreateOrUpdate Link operation. will be added to the HTTP request.
361 362 363 364 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 361 def begin_create_or_update(resource_group_name, hub_name, link_name, parameters, custom_headers:nil) response = begin_create_or_update_async(resource_group_name, hub_name, link_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end |
#begin_create_or_update_async(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
Creates a link or updates an existing link in the hub.
CreateOrUpdate Link operation. to the HTTP request.
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 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 396 def begin_create_or_update_async(resource_group_name, hub_name, link_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, 'link_name is nil' if link_name.nil? fail ArgumentError, "'link_name' should satisfy the constraint - 'MaxLength': '512'" if !link_name.nil? && link_name.length > 512 fail ArgumentError, "'link_name' should satisfy the constraint - 'MinLength': '1'" if !link_name.nil? && link_name.length < 1 fail ArgumentError, "'link_name' should satisfy the constraint - 'Pattern': '^[a-zA-Z][a-zA-Z0-9_]+$'" if !link_name.nil? && link_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_04_26::Models::LinkResourceFormat.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}/links/{linkName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'linkName' => link_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, ) 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::CustomerInsights::Mgmt::V2017_04_26::Models::LinkResourceFormat.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#begin_create_or_update_with_http_info(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Creates a link or updates an existing link in the hub.
CreateOrUpdate Link operation. will be added to the HTTP request.
379 380 381 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 379 def begin_create_or_update_with_http_info(resource_group_name, hub_name, link_name, parameters, custom_headers:nil) begin_create_or_update_async(resource_group_name, hub_name, link_name, parameters, custom_headers:custom_headers).value! end |
#create_or_update(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ LinkResourceFormat
Creates a link or updates an existing link in the hub.
CreateOrUpdate Link operation. will be added to the HTTP request.
40 41 42 43 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 40 def create_or_update(resource_group_name, hub_name, link_name, parameters, custom_headers:nil) response = create_or_update_async(resource_group_name, hub_name, link_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end |
#create_or_update_async(resource_group_name, hub_name, link_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise
CreateOrUpdate Link operation. will be added to the HTTP request.
response.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 57 def create_or_update_async(resource_group_name, hub_name, link_name, parameters, custom_headers:nil) # Send request promise = begin_create_or_update_async(resource_group_name, hub_name, link_name, parameters, custom_headers:custom_headers) promise = promise.then do |response| # Defining deserialization method. deserialize_method = lambda do |parsed_response| result_mapper = Azure::CustomerInsights::Mgmt::V2017_04_26::Models::LinkResourceFormat.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, link_name, custom_headers: nil) ⇒ Object
Deletes a link in the hub.
will be added to the HTTP request.
181 182 183 184 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 181 def delete(resource_group_name, hub_name, link_name, custom_headers:nil) response = delete_async(resource_group_name, hub_name, link_name, custom_headers:custom_headers).value! nil end |
#delete_async(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ Concurrent::Promise
Deletes a link in the hub.
to the HTTP request.
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/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 212 def delete_async(resource_group_name, hub_name, link_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, 'link_name is nil' if link_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}/links/{linkName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'linkName' => link_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, ) 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 end promise.execute end |
#delete_with_http_info(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Deletes a link in the hub.
will be added to the HTTP request.
197 198 199 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 197 def delete_with_http_info(resource_group_name, hub_name, link_name, custom_headers:nil) delete_async(resource_group_name, hub_name, link_name, custom_headers:custom_headers).value! end |
#get(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ LinkResourceFormat
Gets a link in the hub.
will be added to the HTTP request.
86 87 88 89 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 86 def get(resource_group_name, hub_name, link_name, custom_headers:nil) response = get_async(resource_group_name, hub_name, link_name, custom_headers:custom_headers).value! response.body unless response.nil? end |
#get_async(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets a link in the hub.
to the HTTP request.
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 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 117 def get_async(resource_group_name, hub_name, link_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, 'link_name is nil' if link_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}/links/{linkName}' request_url = @base_url || @client.base_url = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'resourceGroupName' => resource_group_name,'hubName' => hub_name,'linkName' => link_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, ) 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_04_26::Models::LinkResourceFormat.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#get_with_http_info(resource_group_name, hub_name, link_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets a link in the hub.
will be added to the HTTP request.
102 103 104 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 102 def get_with_http_info(resource_group_name, hub_name, link_name, custom_headers:nil) get_async(resource_group_name, hub_name, link_name, custom_headers:custom_headers).value! end |
#list_by_hub(resource_group_name, hub_name, custom_headers: nil) ⇒ Array<LinkResourceFormat>
Gets all the links in the specified hub.
will be added to the HTTP request.
266 267 268 269 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 266 def list_by_hub(resource_group_name, hub_name, custom_headers:nil) first_page = list_by_hub_as_lazy(resource_group_name, hub_name, custom_headers:custom_headers) first_page.get_all_items end |
#list_by_hub_as_lazy(resource_group_name, hub_name, custom_headers: nil) ⇒ LinkListResult
Gets all the links in the specified hub.
will be added to the HTTP request.
559 560 561 562 563 564 565 566 567 568 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 559 def list_by_hub_as_lazy(resource_group_name, hub_name, custom_headers:nil) response = list_by_hub_async(resource_group_name, hub_name, custom_headers: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:custom_headers) end page end end |
#list_by_hub_async(resource_group_name, hub_name, custom_headers: nil) ⇒ Concurrent::Promise
Gets all the links in the specified hub.
to the HTTP request.
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 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 295 def list_by_hub_async(resource_group_name, hub_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, '@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}/links' request_url = @base_url || @client.base_url = { 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: {'api-version' => @client.api_version}, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:get, path_template, ) 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_04_26::Models::LinkListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., e.backtrace, result) end end result end promise.execute end |
#list_by_hub_next(next_page_link, custom_headers: nil) ⇒ LinkListResult
Gets all the links in the specified hub.
to List operation. will be added to the HTTP request.
471 472 473 474 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 471 def list_by_hub_next(next_page_link, custom_headers:nil) response = list_by_hub_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end |
#list_by_hub_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise
Gets all the links in the specified hub.
to List operation. to the HTTP request.
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 534 535 536 537 538 539 540 541 542 543 544 545 546 547 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 500 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 = {} 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 = { 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, ) 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_04_26::Models::LinkListResult.mapper() result.body = @client.deserialize(result_mapper, parsed_response) rescue Exception => e fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e., 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 the links in the specified hub.
to List operation. will be added to the HTTP request.
486 487 488 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 486 def list_by_hub_next_with_http_info(next_page_link, custom_headers:nil) list_by_hub_next_async(next_page_link, custom_headers:custom_headers).value! end |
#list_by_hub_with_http_info(resource_group_name, hub_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse
Gets all the links in the specified hub.
will be added to the HTTP request.
281 282 283 |
# File 'lib/2017-04-26/generated/azure_mgmt_customer_insights/links.rb', line 281 def list_by_hub_with_http_info(resource_group_name, hub_name, custom_headers:nil) list_by_hub_async(resource_group_name, hub_name, custom_headers:custom_headers).value! end |