Method: Fastly::LoggingAzureblobApi#create_log_azure

Defined in:

lib/fastly/api/logging_azureblob_api.rb

#create_log_azure(opts = {}) ⇒ LoggingAzureblobResponse

Create an Azure Blob Storage log endpoint Create an 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)

• :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 `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.

• :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" %>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 `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. (default to 2)

• :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 `zstd`, `snappy`, and `gzip`. Specifying both `compression_codec` and `gzip_level` 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 `0`, no compression). Specifying both `compression_codec` and `gzip_level` 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:

• (LoggingAzureblobResponse)

# File 'lib/fastly/api/logging_azureblob_api.rb', line 41

def create_log_azure(opts = {})
  data, _status_code, _headers = create_log_azure_with_http_info(opts)
  data
end