class Azure::CustomerInsights::Mgmt::V2017_04_26::Views
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.
Attributes
@return [CustomerInsightsManagementClient] reference to the CustomerInsightsManagementClient
Private Class Methods
Creates and initializes a new instance of the Views
class. @param client service class for accessing basic functionality.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 20 def initialize(client) @client = client end
Private Instance Methods
Creates a view or updates an exisiting view in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param view_name [String] The name of the view. @param parameters [ViewResourceFormat] Parameters supplied to the CreateOrUpdate View operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ViewResourceFormat] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 136 def create_or_update(resource_group_name, hub_name, view_name, parameters, custom_headers:nil) response = create_or_update_async(resource_group_name, hub_name, view_name, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Creates a view or updates an exisiting view in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param view_name [String] The name of the view. @param parameters [ViewResourceFormat] Parameters supplied to the CreateOrUpdate View operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 171 def create_or_update_async(resource_group_name, hub_name, view_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, 'view_name is nil' if view_name.nil? fail ArgumentError, "'view_name' should satisfy the constraint - 'MaxLength': '512'" if !view_name.nil? && view_name.length > 512 fail ArgumentError, "'view_name' should satisfy the constraint - 'MinLength': '1'" if !view_name.nil? && view_name.length < 1 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::ViewResourceFormat.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}/views/{viewName}' 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,'viewName' => view_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 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::ViewResourceFormat.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
Creates a view or updates an exisiting view in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param view_name [String] The name of the view. @param parameters [ViewResourceFormat] Parameters supplied to the CreateOrUpdate View operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 154 def create_or_update_with_http_info(resource_group_name, hub_name, view_name, parameters, custom_headers:nil) create_or_update_async(resource_group_name, hub_name, view_name, parameters, custom_headers:custom_headers).value! end
Deletes a view in the specified hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param view_name [String] The name of the view. @param user_id [String] The user ID. Use * to retreive hub level view. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 346 def delete(resource_group_name, hub_name, view_name, user_id, custom_headers:nil) response = delete_async(resource_group_name, hub_name, view_name, user_id, custom_headers:custom_headers).value! nil end
Deletes a view in the specified hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param view_name [String] The name of the view. @param user_id [String] The user ID. Use * to retreive hub level view. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 379 def delete_async(resource_group_name, hub_name, view_name, user_id, 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, 'view_name is nil' if view_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? fail ArgumentError, 'user_id is nil' if user_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}/views/{viewName}' 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,'viewName' => view_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version,'userId' => user_id}, 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 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
Deletes a view in the specified hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param view_name [String] The name of the view. @param user_id [String] The user ID. Use * to retreive hub level view. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 363 def delete_with_http_info(resource_group_name, hub_name, view_name, user_id, custom_headers:nil) delete_async(resource_group_name, hub_name, view_name, user_id, custom_headers:custom_headers).value! end
Gets a view in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param view_name [String] The name of the view. @param user_id [String] The user ID. Use * to retreive hub level view. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ViewResourceFormat] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 247 def get(resource_group_name, hub_name, view_name, user_id, custom_headers:nil) response = get_async(resource_group_name, hub_name, view_name, user_id, custom_headers:custom_headers).value! response.body unless response.nil? end
Gets a view in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param view_name [String] The name of the view. @param user_id [String] The user ID. Use * to retreive hub level view. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 280 def get_async(resource_group_name, hub_name, view_name, user_id, 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, 'view_name is nil' if view_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? fail ArgumentError, 'user_id is nil' if user_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}/views/{viewName}' 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,'viewName' => view_name,'subscriptionId' => @client.subscription_id}, query_params: {'api-version' => @client.api_version,'userId' => user_id}, 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_04_26::Models::ViewResourceFormat.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
Gets a view in the hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param view_name [String] The name of the view. @param user_id [String] The user ID. Use * to retreive hub level view. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 264 def get_with_http_info(resource_group_name, hub_name, view_name, user_id, custom_headers:nil) get_async(resource_group_name, hub_name, view_name, user_id, custom_headers:custom_headers).value! end
Gets all available views for given user in the specified hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param user_id [String] The user ID. Use * to retreive hub level views. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<ViewResourceFormat>] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 38 def list_by_hub(resource_group_name, hub_name, user_id, custom_headers:nil) first_page = list_by_hub_as_lazy(resource_group_name, hub_name, user_id, custom_headers:custom_headers) first_page.get_all_items end
Gets all available views for given user in the specified hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param user_id [String] The user ID. Use * to retreive hub level views. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ViewListResult] which provide lazy access to pages of the response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 523 def list_by_hub_as_lazy(resource_group_name, hub_name, user_id, custom_headers:nil) response = list_by_hub_async(resource_group_name, hub_name, user_id, 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
Gets all available views for given user in the specified hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param user_id [String] The user ID. Use * to retreive hub level views. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 69 def list_by_hub_async(resource_group_name, hub_name, user_id, 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? fail ArgumentError, 'user_id is nil' if user_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}/views' 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: {'api-version' => @client.api_version,'userId' => user_id}, 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_04_26::Models::ViewListResult.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
Gets all available views for given user in the specified hub.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [ViewListResult] operation results.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 434 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
Gets all available views for given user in the specified hub.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Concurrent::Promise] Promise object which holds the HTTP response.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 463 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 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_04_26::Models::ViewListResult.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
Gets all available views for given user in the specified hub.
@param next_page_link [String] The NextLink from the previous successful call to List operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 449 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
Gets all available views for given user in the specified hub.
@param resource_group_name [String] The name of the resource group. @param hub_name [String] The name of the hub. @param user_id [String] The user ID. Use * to retreive hub level views. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [MsRestAzure::AzureOperationResponse] HTTP response information.
# File lib/2017-04-26/generated/azure_mgmt_customer_insights/views.rb, line 54 def list_by_hub_with_http_info(resource_group_name, hub_name, user_id, custom_headers:nil) list_by_hub_async(resource_group_name, hub_name, user_id, custom_headers:custom_headers).value! end