class Azure::MobileEngagement::Mgmt::V2014_12_01::Campaigns
Microsoft Azure
Mobile Engagement REST APIs.
Attributes
@return [EngagementManagementClient] reference to the EngagementManagementClient
Private Class Methods
Creates and initializes a new instance of the Campaigns
class. @param client service class for accessing basic functionality.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 17 def initialize(client) @client = client end
Private Instance Methods
Activate a campaign previously created by a call to Create campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignStateResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 999 def activate(resource_group_name, app_collection, app_name, kind, id, custom_headers:nil) response = activate_async(resource_group_name, app_collection, app_name, kind, id, custom_headers:custom_headers).value! response.body unless response.nil? end
Activate a campaign previously created by a call to Create campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1036 def activate_async(resource_group_name, app_collection, app_name, kind, id, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'id is nil' if id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/activate' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name,'kind' => kind,'id' => 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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignStateResult.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
Activate a campaign previously created by a call to Create campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1018 def activate_with_http_info(resource_group_name, app_collection, app_name, kind, id, custom_headers:nil) activate_async(resource_group_name, app_collection, app_name, kind, id, custom_headers:custom_headers).value! end
Create a push campaign (announcement, poll, data push or native push).
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param parameters [Campaign] Parameters supplied to the Update Campaign operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignStateResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 205 def create(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:nil) response = create_async(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Create a push campaign (announcement, poll, data push or native push).
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param parameters [Campaign] Parameters supplied to the Update Campaign 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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 244 def create_async(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::Campaign.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name,'kind' => kind}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:post, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 201 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.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 == 201 begin parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content) result_mapper = Azure::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignStateResult.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 a push campaign (announcement, poll, data push or native push).
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param parameters [Campaign] Parameters supplied to the Update Campaign 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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 225 def create_with_http_info(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:nil) create_async(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:custom_headers).value! end
Delete a campaign previously created by a call to Create campaign.
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 554 def delete(kind, id, resource_group_name, app_collection, app_name, custom_headers:nil) response = delete_async(kind, id, resource_group_name, app_collection, app_name, custom_headers:custom_headers).value! nil end
Delete a campaign previously created by a call to Create campaign.
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 591 def delete_async(kind, id, resource_group_name, app_collection, app_name, custom_headers:nil) fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'id is nil' if id.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'kind' => kind,'id' => id,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name}, 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 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.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 a campaign previously created by a call to Create campaign.
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 573 def delete_with_http_info(kind, id, resource_group_name, app_collection, app_name, custom_headers:nil) delete_async(kind, id, resource_group_name, app_collection, app_name, custom_headers:custom_headers).value! end
Finish a push campaign previously activated by a call to Activate campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignStateResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1444 def finish(resource_group_name, app_collection, app_name, kind, id, custom_headers:nil) response = finish_async(resource_group_name, app_collection, app_name, kind, id, custom_headers:custom_headers).value! response.body unless response.nil? end
Finish a push campaign previously activated by a call to Activate campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1481 def finish_async(resource_group_name, app_collection, app_name, kind, id, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'id is nil' if id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/finish' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name,'kind' => kind,'id' => 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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignStateResult.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
Finish a push campaign previously activated by a call to Activate campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1463 def finish_with_http_info(resource_group_name, app_collection, app_name, kind, id, custom_headers:nil) finish_async(resource_group_name, app_collection, app_name, kind, id, custom_headers:custom_headers).value! end
The Get campaign operation retrieves information about a previously created campaign.
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 322 def get(kind, id, resource_group_name, app_collection, app_name, custom_headers:nil) response = get_async(kind, id, resource_group_name, app_collection, app_name, custom_headers:custom_headers).value! response.body unless response.nil? end
The Get campaign operation retrieves information about a previously created campaign.
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 361 def get_async(kind, id, resource_group_name, app_collection, app_name, custom_headers:nil) fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'id is nil' if id.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'kind' => kind,'id' => id,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name}, 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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignResult.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
The Get campaign operation retrieves information about a previously created campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param name [String] Campaign name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 652 def get_by_name(resource_group_name, app_collection, app_name, kind, name, custom_headers:nil) response = get_by_name_async(resource_group_name, app_collection, app_name, kind, name, custom_headers:custom_headers).value! response.body unless response.nil? end
The Get campaign operation retrieves information about a previously created campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param name [String] Campaign name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 691 def get_by_name_async(resource_group_name, app_collection, app_name, kind, name, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'name is nil' if name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaignsByName/{kind}/{name}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name,'kind' => kind,'name' => name}, 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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignResult.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
The Get campaign operation retrieves information about a previously created campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param name [String] Campaign name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 672 def get_by_name_with_http_info(resource_group_name, app_collection, app_name, kind, name, custom_headers:nil) get_by_name_async(resource_group_name, app_collection, app_name, kind, name, custom_headers:custom_headers).value! end
Get all the campaign statistics.
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignStatisticsResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1337 def get_statistics(kind, id, resource_group_name, app_collection, app_name, custom_headers:nil) response = get_statistics_async(kind, id, resource_group_name, app_collection, app_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Get all the campaign statistics.
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1374 def get_statistics_async(kind, id, resource_group_name, app_collection, app_name, custom_headers:nil) fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'id is nil' if id.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/statistics' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'kind' => kind,'id' => id,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name}, 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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignStatisticsResult.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 all the campaign statistics.
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1356 def get_statistics_with_http_info(kind, id, resource_group_name, app_collection, app_name, custom_headers:nil) get_statistics_async(kind, id, resource_group_name, app_collection, app_name, custom_headers:custom_headers).value! end
The Get campaign operation retrieves information about a previously created campaign.
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 342 def get_with_http_info(kind, id, resource_group_name, app_collection, app_name, custom_headers:nil) get_async(kind, id, resource_group_name, app_collection, app_name, custom_headers:custom_headers).value! end
Get the list of campaigns.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param skip [Integer] Control paging of campaigns, start results at the given offset, defaults to 0 (1st page of data). @param top [Integer] Control paging of campaigns, number of campaigns to return with each call. It returns all campaigns by default. When specifying $top parameter, the response contains a `nextLink` property describing the path to get the next page if there are more results. @param filter [String] Filter can be used to restrict the results to campaigns matching a specific state. The syntax is `$filter=state eq 'draft'`. Valid state values are: draft, scheduled, in-progress, and finished. Only the eq operator and the state property are supported. @param orderby [String] Sort results by an expression which looks like `$orderby=id asc` (this example is actually the default behavior). The syntax is orderby={property} {direction} or just orderby={property}. The available sorting properties are id, name, state, activatedDate, and finishedDate. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one property at a time can be used for sorting. @param search [String] Restrict results to campaigns matching the optional `search` expression. This currently performs the search based on the name on the campaign only, case insensitive. If the campaign contains the value of the `search` parameter anywhere in the name, it matches. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [Array<CampaignListResult>] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 58 def list(resource_group_name, app_collection, app_name, kind, skip:nil, top:nil, filter:nil, orderby:nil, search:nil, custom_headers:nil) first_page = list_as_lazy(resource_group_name, app_collection, app_name, kind, skip:skip, top:top, filter:filter, orderby:orderby, search:search, custom_headers:custom_headers) first_page.get_all_items end
Get the list of campaigns.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param skip [Integer] Control paging of campaigns, start results at the given offset, defaults to 0 (1st page of data). @param top [Integer] Control paging of campaigns, number of campaigns to return with each call. It returns all campaigns by default. When specifying $top parameter, the response contains a `nextLink` property describing the path to get the next page if there are more results. @param filter [String] Filter can be used to restrict the results to campaigns matching a specific state. The syntax is `$filter=state eq 'draft'`. Valid state values are: draft, scheduled, in-progress, and finished. Only the eq operator and the state property are supported. @param orderby [String] Sort results by an expression which looks like `$orderby=id asc` (this example is actually the default behavior). The syntax is orderby={property} {direction} or just orderby={property}. The available sorting properties are id, name, state, activatedDate, and finishedDate. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one property at a time can be used for sorting. @param search [String] Restrict results to campaigns matching the optional `search` expression. This currently performs the search based on the name on the campaign only, case insensitive. If the campaign contains the value of the `search` parameter anywhere in the name, it matches. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignsListResult] which provide lazy access to pages of the response.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1660 def list_as_lazy(resource_group_name, app_collection, app_name, kind, skip:nil, top:nil, filter:nil, orderby:nil, search:nil, custom_headers:nil) response = list_async(resource_group_name, app_collection, app_name, kind, skip:skip, top:top, filter:filter, orderby:orderby, search:search, custom_headers:custom_headers).value! unless response.nil? page = response.body page.next_method = Proc.new do |next_page_link| list_next_async(next_page_link, custom_headers:custom_headers) end page end end
Get the list of campaigns.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param skip [Integer] Control paging of campaigns, start results at the given offset, defaults to 0 (1st page of data). @param top [Integer] Control paging of campaigns, number of campaigns to return with each call. It returns all campaigns by default. When specifying $top parameter, the response contains a `nextLink` property describing the path to get the next page if there are more results. @param filter [String] Filter can be used to restrict the results to campaigns matching a specific state. The syntax is `$filter=state eq 'draft'`. Valid state values are: draft, scheduled, in-progress, and finished. Only the eq operator and the state property are supported. @param orderby [String] Sort results by an expression which looks like `$orderby=id asc` (this example is actually the default behavior). The syntax is orderby={property} {direction} or just orderby={property}. The available sorting properties are id, name, state, activatedDate, and finishedDate. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one property at a time can be used for sorting. @param search [String] Restrict results to campaigns matching the optional `search` expression. This currently performs the search based on the name on the campaign only, case insensitive. If the campaign contains the value of the `search` parameter anywhere in the name, it matches. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 135 def list_async(resource_group_name, app_collection, app_name, kind, skip:nil, top:nil, filter:nil, orderby:nil, search:nil, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'kind is nil' if kind.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name,'kind' => kind}, query_params: {'api-version' => @client.api_version,'$skip' => skip,'$top' => top,'$filter' => filter,'$orderby' => orderby,'$search' => search}, 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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignsListResult.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 the list of campaigns.
@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 [CampaignsListResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1547 def list_next(next_page_link, custom_headers:nil) response = list_next_async(next_page_link, custom_headers:custom_headers).value! response.body unless response.nil? end
Get the list of campaigns.
@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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1576 def list_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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignsListResult.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 the list of campaigns.
@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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1562 def list_next_with_http_info(next_page_link, custom_headers:nil) list_next_async(next_page_link, custom_headers:custom_headers).value! end
Get the list of campaigns.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param skip [Integer] Control paging of campaigns, start results at the given offset, defaults to 0 (1st page of data). @param top [Integer] Control paging of campaigns, number of campaigns to return with each call. It returns all campaigns by default. When specifying $top parameter, the response contains a `nextLink` property describing the path to get the next page if there are more results. @param filter [String] Filter can be used to restrict the results to campaigns matching a specific state. The syntax is `$filter=state eq 'draft'`. Valid state values are: draft, scheduled, in-progress, and finished. Only the eq operator and the state property are supported. @param orderby [String] Sort results by an expression which looks like `$orderby=id asc` (this example is actually the default behavior). The syntax is orderby={property} {direction} or just orderby={property}. The available sorting properties are id, name, state, activatedDate, and finishedDate. The available directions are asc (for ascending order) and desc (for descending order). When not specified the asc direction is used. Only one property at a time can be used for sorting. @param search [String] Restrict results to campaigns matching the optional `search` expression. This currently performs the search based on the name on the campaign only, case insensitive. If the campaign contains the value of the `search` parameter anywhere in the name, it matches. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 97 def list_with_http_info(resource_group_name, app_collection, app_name, kind, skip:nil, top:nil, filter:nil, orderby:nil, search:nil, custom_headers:nil) list_async(resource_group_name, app_collection, app_name, kind, skip:skip, top:top, filter:filter, orderby:orderby, search:search, custom_headers:custom_headers).value! end
Push a previously saved campaign (created with Create campaign) to a set of devices.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param parameters [CampaignPushParameters] Parameters supplied to the Push Campaign operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignPushResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1216 def push(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:nil) response = push_async(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Push a previously saved campaign (created with Create campaign) to a set of devices.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param parameters [CampaignPushParameters] Parameters supplied to the Push Campaign 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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1259 def push_async(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'id is nil' if id.nil? fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignPushParameters.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/push' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name,'kind' => kind,'id' => id}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:post, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignPushResult.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
Push a previously saved campaign (created with Create campaign) to a set of devices.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param parameters [CampaignPushParameters] Parameters supplied to the Push Campaign 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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1238 def push_with_http_info(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:nil) push_async(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:custom_headers).value! end
Suspend a push campaign previously activated by a call to Activate campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignStateResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1106 def suspend(resource_group_name, app_collection, app_name, kind, id, custom_headers:nil) response = suspend_async(resource_group_name, app_collection, app_name, kind, id, custom_headers:custom_headers).value! response.body unless response.nil? end
Suspend a push campaign previously activated by a call to Activate campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1143 def suspend_async(resource_group_name, app_collection, app_name, kind, id, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'id is nil' if id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/suspend' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name,'kind' => kind,'id' => 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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignStateResult.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
Suspend a push campaign previously activated by a call to Activate campaign.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 1125 def suspend_with_http_info(resource_group_name, app_collection, app_name, kind, id, custom_headers:nil) suspend_async(resource_group_name, app_collection, app_name, kind, id, custom_headers:custom_headers).value! end
Test a new campaign on a set of devices.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param parameters [CampaignTestNewParameters] Parameters supplied to the Test Campaign operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignState] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 883 def test_new(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:nil) response = test_new_async(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Test a new campaign on a set of devices.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param parameters [CampaignTestNewParameters] Parameters supplied to the Test Campaign 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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 922 def test_new_async(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignTestNewParameters.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/test' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name,'kind' => kind}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:post, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignState.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
Test a new campaign on a set of devices.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param parameters [CampaignTestNewParameters] Parameters supplied to the Test Campaign 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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 903 def test_new_with_http_info(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:nil) test_new_async(resource_group_name, app_collection, app_name, kind, parameters, custom_headers:custom_headers).value! end
Test an existing campaign (created with Create campaign) on a set of devices.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param parameters [CampaignTestSavedParameters] Parameters supplied to the Test Campaign operation. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignStateResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 763 def test_saved(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:nil) response = test_saved_async(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:custom_headers).value! response.body unless response.nil? end
Test an existing campaign (created with Create campaign) on a set of devices.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param parameters [CampaignTestSavedParameters] Parameters supplied to the Test Campaign 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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 804 def test_saved_async(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:nil) fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'id is nil' if id.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil? fail ArgumentError, 'parameters is nil' if parameters.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignTestSavedParameters.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}/test' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name,'kind' => kind,'id' => id}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(:post, path_template, options) promise = promise.then do |result| http_response = result.response status_code = http_response.status response_content = http_response.body unless status_code == 200 error_model = JSON.load(response_content) fail MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignStateResult.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
Test an existing campaign (created with Create campaign) on a set of devices.
@param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param parameters [CampaignTestSavedParameters] Parameters supplied to the Test Campaign 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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 784 def test_saved_with_http_info(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:nil) test_saved_async(resource_group_name, app_collection, app_name, kind, id, parameters, custom_headers:custom_headers).value! end
Update an existing push campaign (announcement, poll, data push or native push).
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param parameters [Campaign] Parameters supplied to the Update Campaign operation. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.
@return [CampaignStateResult] operation results.
# File lib/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 434 def update(kind, id, parameters, resource_group_name, app_collection, app_name, custom_headers:nil) response = update_async(kind, id, parameters, resource_group_name, app_collection, app_name, custom_headers:custom_headers).value! response.body unless response.nil? end
Update an existing push campaign (announcement, poll, data push or native push).
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param parameters [Campaign] Parameters supplied to the Update Campaign operation. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 477 def update_async(kind, id, parameters, resource_group_name, app_collection, app_name, custom_headers:nil) fail ArgumentError, 'kind is nil' if kind.nil? fail ArgumentError, 'id is nil' if id.nil? fail ArgumentError, 'parameters is nil' if parameters.nil? fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil? fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil? fail ArgumentError, 'app_collection is nil' if app_collection.nil? fail ArgumentError, 'app_name is nil' if app_name.nil? fail ArgumentError, '@client.api_version is nil' if @client.api_version.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::MobileEngagement::Mgmt::V2014_12_01::Models::Campaign.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.MobileEngagement/appcollections/{appCollection}/apps/{appName}/campaigns/{kind}/{id}' request_url = @base_url || @client.base_url options = { middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]], path_params: {'kind' => kind,'id' => id,'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'appCollection' => app_collection,'appName' => app_name}, query_params: {'api-version' => @client.api_version}, body: request_content, headers: request_headers.merge(custom_headers || {}), base_url: request_url } promise = @client.make_request_async(: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 MsRest::HttpOperationError.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::MobileEngagement::Mgmt::V2014_12_01::Models::CampaignStateResult.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
Update an existing push campaign (announcement, poll, data push or native push).
@param kind [CampaignKinds] Campaign kind. Possible values include: 'announcements', 'polls', 'dataPushes', 'nativePushes' @param id [Integer] Campaign identifier. @param parameters [Campaign] Parameters supplied to the Update Campaign operation. @param resource_group_name [String] The name of the resource group. @param app_collection [String] Application collection. @param app_name [String] Application resource name. @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/2014-12-01/generated/azure_mgmt_mobile_engagement/campaigns.rb, line 456 def update_with_http_info(kind, id, parameters, resource_group_name, app_collection, app_name, custom_headers:nil) update_async(kind, id, parameters, resource_group_name, app_collection, app_name, custom_headers:custom_headers).value! end