Method: Fastly::LoggingAzureblobApi#update_log_azure_with_http_info

Defined in:
lib/fastly/api/logging_azureblob_api.rb

#update_log_azure_with_http_info(opts = {}) ⇒ Array<(LoggingAzureblobResponse, Integer, Hash)>

Update an Azure Blob Storage log endpoint Update the Azure Blob Storage logging endpoint for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {})

    a customizable set of options

Options Hash (opts):

  • :service_id (String)

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer)

    Integer identifying a service version. (required)

  • :logging_azureblob_name (String)

    The name for the real-time logging configuration. (required)

  • :name (String)

    The name for the real-time logging configuration.

  • :placement (String)

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String)

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String)

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). (default to ‘%h %l %u %t "%r" %&gt;s %b’)

  • :format_version (Integer)

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :message_type (String)

    How the message should be formatted. (default to ‘classic’)

  • :timestamp_format (String)

    A timestamp format

  • :compression_codec (String)

    The codec used for compressing your logs. Valid values are &#x60;zstd&#x60;, &#x60;snappy&#x60;, and &#x60;gzip&#x60;. Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error.

  • :period (Integer)

    How frequently log files are finalized so they can be available for reading (in seconds). (default to 3600)

  • :gzip_level (Integer)

    The level of gzip encoding when sending logs (default &#x60;0&#x60;, no compression). Specifying both &#x60;compression_codec&#x60; and &#x60;gzip_level&#x60; in the same API request will result in an error. (default to 0)

  • :path (String)

    The path to upload logs to. (default to ‘null’)

  • :account_name (String)

    The unique Azure Blob Storage namespace in which your data objects are stored. Required.

  • :container (String)

    The name of the Azure Blob Storage container in which to store logs. Required.

  • :sas_token (String)

    The Azure shared access signature providing write access to the blob service objects. Be sure to update your token before it expires or the logging functionality will not work. Required.

  • :public_key (String)

    A PGP public key that Fastly will use to encrypt your log files before writing them to disk. (default to ‘null’)

  • :file_max_bytes (Integer)

    The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.)

Returns:

  • (Array<(LoggingAzureblobResponse, Integer, Hash)>)

    LoggingAzureblobResponse data, response status code and response headers



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
# File 'lib/fastly/api/logging_azureblob_api.rb', line 436

def update_log_azure_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingAzureblobApi.update_log_azure ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_azureblob_name = opts[:'logging_azureblob_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingAzureblobApi.update_log_azure"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingAzureblobApi.update_log_azure"
  end
  # verify the required parameter 'logging_azureblob_name' is set
  if @api_client.config.client_side_validation && logging_azureblob_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_azureblob_name' when calling LoggingAzureblobApi.update_log_azure"
  end
  allowable_values = ["none", "waf_debug", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  allowable_values = ["classic", "loggly", "logplex", "blank"]
  if @api_client.config.client_side_validation && opts[:'message_type'] && !allowable_values.include?(opts[:'message_type'])
    fail ArgumentError, "invalid value for \"message_type\", must be one of #{allowable_values}"
  end
  allowable_values = ["zstd", "snappy", "gzip"]
  if @api_client.config.client_side_validation && opts[:'compression_codec'] && !allowable_values.include?(opts[:'compression_codec'])
    fail ArgumentError, "invalid value for \"compression_codec\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'file_max_bytes'].nil? && opts[:'file_max_bytes'] < 1048576
    fail ArgumentError, 'invalid value for "opts[:"file_max_bytes"]" when calling LoggingAzureblobApi.update_log_azure, must be greater than or equal to 1048576.'
  end

  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/azureblob/{logging_azureblob_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_azureblob_name' + '}', CGI.escape(logging_azureblob_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['message_type'] = opts[:'message_type'] if !opts[:'message_type'].nil?
  form_params['timestamp_format'] = opts[:'timestamp_format'] if !opts[:'timestamp_format'].nil?
  form_params['compression_codec'] = opts[:'compression_codec'] if !opts[:'compression_codec'].nil?
  form_params['period'] = opts[:'period'] if !opts[:'period'].nil?
  form_params['gzip_level'] = opts[:'gzip_level'] if !opts[:'gzip_level'].nil?
  form_params['path'] = opts[:'path'] if !opts[:'path'].nil?
  form_params['account_name'] = opts[:'account_name'] if !opts[:'account_name'].nil?
  form_params['container'] = opts[:'container'] if !opts[:'container'].nil?
  form_params['sas_token'] = opts[:'sas_token'] if !opts[:'sas_token'].nil?
  form_params['public_key'] = opts[:'public_key'] if !opts[:'public_key'].nil?
  form_params['file_max_bytes'] = opts[:'file_max_bytes'] if !opts[:'file_max_bytes'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingAzureblobResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingAzureblobApi.update_log_azure",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingAzureblobApi#update_log_azure\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end