class Azure::OperationalInsights::Mgmt::V2020_03_01_preview::WorkspacePurge

Operational Insights Client

Attributes

client[R]

@return [OperationalInsightsManagementClient] reference to the OperationalInsightsManagementClient

Public Class Methods

new(client) click to toggle source

Creates and initializes a new instance of the WorkspacePurge class. @param client service class for accessing basic functionality.

# File lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/workspace_purge.rb, line 17
def initialize(client)
  @client = client
end

Public Instance Methods

get_purge_status(resource_group_name, workspace_name, purge_id, custom_headers:nil) click to toggle source

Gets status of an ongoing purge operation.

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param purge_id [String] In a purge status request, this is the Id of the operation the status of which is returned. @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [WorkspacePurgeStatusResponse] operation results.

# File lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/workspace_purge.rb, line 177
def get_purge_status(resource_group_name, workspace_name, purge_id, custom_headers:nil)
  response = get_purge_status_async(resource_group_name, workspace_name, purge_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
get_purge_status_async(resource_group_name, workspace_name, purge_id, custom_headers:nil) click to toggle source

Gets status of an ongoing purge operation.

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param purge_id [String] In a purge status request, this is the Id of the operation the status of which is returned. @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/2020-03-01-preview/generated/azure_mgmt_operational_insights/workspace_purge.rb, line 212
def get_purge_status_async(resource_group_name, workspace_name, purge_id, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '63'" if !workspace_name.nil? && workspace_name.length > 63
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '4'" if !workspace_name.nil? && workspace_name.length < 4
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$'" if !workspace_name.nil? && workspace_name.match(Regexp.new('^^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$$')).nil?
  fail ArgumentError, 'purge_id is nil' if purge_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.OperationalInsights/workspaces/{workspaceName}/operations/{purgeId}'

  request_url = @base_url || @client.base_url

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

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

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::OperationalInsights::Mgmt::V2020_03_01_preview::Models::WorkspacePurgeStatusResponse.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_purge_status_with_http_info(resource_group_name, workspace_name, purge_id, custom_headers:nil) click to toggle source

Gets status of an ongoing purge operation.

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param purge_id [String] In a purge status request, this is the Id of the operation the status of which is returned. @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/2020-03-01-preview/generated/azure_mgmt_operational_insights/workspace_purge.rb, line 195
def get_purge_status_with_http_info(resource_group_name, workspace_name, purge_id, custom_headers:nil)
  get_purge_status_async(resource_group_name, workspace_name, purge_id, custom_headers:custom_headers).value!
end
purge(resource_group_name, workspace_name, body, custom_headers:nil) click to toggle source

Purges data in an Log Analytics workspace by a set of user-defined filters.

In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param body [WorkspacePurgeBody] Describes the body of a request to purge data in a single table of an Log Analytics Workspace @param custom_headers [Hash{String => String}] A hash of custom headers that will be added to the HTTP request.

@return [WorkspacePurgeResponse] operation results.

# File lib/2020-03-01-preview/generated/azure_mgmt_operational_insights/workspace_purge.rb, line 44
def purge(resource_group_name, workspace_name, body, custom_headers:nil)
  response = purge_async(resource_group_name, workspace_name, body, custom_headers:custom_headers).value!
  response.body unless response.nil?
end
purge_async(resource_group_name, workspace_name, body, custom_headers:nil) click to toggle source

Purges data in an Log Analytics workspace by a set of user-defined filters.

In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param body [WorkspacePurgeBody] Describes the body of a request to purge data in a single table of an Log Analytics Workspace @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/2020-03-01-preview/generated/azure_mgmt_operational_insights/workspace_purge.rb, line 93
def purge_async(resource_group_name, workspace_name, body, custom_headers:nil)
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, "'@client.api_version' should satisfy the constraint - 'MinLength': '1'" if !@client.api_version.nil? && @client.api_version.length < 1
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'MinLength': '1'" if !@client.subscription_id.nil? && @client.subscription_id.length < 1
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '63'" if !workspace_name.nil? && workspace_name.length > 63
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '4'" if !workspace_name.nil? && workspace_name.length < 4
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$'" if !workspace_name.nil? && workspace_name.match(Regexp.new('^^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$$')).nil?
  fail ArgumentError, 'body is nil' if body.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::OperationalInsights::Mgmt::V2020_03_01_preview::Models::WorkspacePurgeBody.mapper()
  request_content = @client.serialize(request_mapper,  body)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/purge'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'subscriptionId' => @client.subscription_id,'workspaceName' => workspace_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(: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 == 202
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 202
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::OperationalInsights::Mgmt::V2020_03_01_preview::Models::WorkspacePurgeResponse.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
purge_with_http_info(resource_group_name, workspace_name, body, custom_headers:nil) click to toggle source

Purges data in an Log Analytics workspace by a set of user-defined filters.

In order to manage system resources, purge requests are throttled at 50 requests per hour. You should batch the execution of purge requests by sending a single command whose predicate includes all user identities that require purging. Use the in operator to specify multiple identities. You should run the query prior to using for a purge request to verify that the results are expected.

@param resource_group_name [String] The name of the resource group. The name is case insensitive. @param workspace_name [String] The name of the workspace. @param body [WorkspacePurgeBody] Describes the body of a request to purge data in a single table of an Log Analytics Workspace @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/2020-03-01-preview/generated/azure_mgmt_operational_insights/workspace_purge.rb, line 69
def purge_with_http_info(resource_group_name, workspace_name, body, custom_headers:nil)
  purge_async(resource_group_name, workspace_name, body, custom_headers:custom_headers).value!
end