The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

FASTLY / WebService-Fastly-9.01 / docs / LoggingAzureblobApi.md

WebService::Fastly::LoggingAzureblobApi

Load the API package


            

              
              
use WebService::Fastly::Object::LoggingAzureblobApi;

[!NOTE] All URIs are relative to https://api.fastly.com

Method | HTTP request | Description ------ | ------------ | ----------- create_log_azure | POST /service/{service_id}/version/{version_id}/logging/azureblob | Create an Azure Blob Storage log endpoint delete_log_azure | DELETE /service/{service_id}/version/{version_id}/logging/azureblob/{logging_azureblob_name} | Delete the Azure Blob Storage log endpoint get_log_azure | GET /service/{service_id}/version/{version_id}/logging/azureblob/{logging_azureblob_name} | Get an Azure Blob Storage log endpoint list_log_azure | GET /service/{service_id}/version/{version_id}/logging/azureblob | List Azure Blob Storage log endpoints update_log_azure | PUT /service/{service_id}/version/{version_id}/logging/azureblob/{logging_azureblob_name} | Update an Azure Blob Storage log endpoint

create_log_azure

LoggingAzureblobResponse create_log_azure(service_id => $service_id, version_id => $version_id, name => $name, placement => $placement, response_condition => $response_condition, format => $format, format_version => $format_version, message_type => $message_type, timestamp_format => $timestamp_format, compression_codec => $compression_codec, period => $period, gzip_level => $gzip_level, path => $path, account_name => $account_name, container => $container, sas_token => $sas_token, public_key => $public_key, file_max_bytes => $file_max_bytes)

Create an Azure Blob Storage log endpoint

Create an Azure Blob Storage logging endpoint for a particular service and version.

Example


            

              
              
use Data::Dumper;
use WebService::Fastly::LoggingAzureblobApi;
my $api_instance = WebService::Fastly::LoggingAzureblobApi->new(
    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $name = "name_example"; # string | The name for the real-time logging configuration.
my $placement = "placement_example"; # 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`. 
my $response_condition = "response_condition_example"; # string | The name of an existing condition in the configured endpoint, or leave blank to always execute.
my $format = '%h %l %u %t "%r" %>s %b'; # string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
my $format_version = 2; # int | 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`. 
my $message_type = 'classic'; # string | How the message should be formatted.
my $timestamp_format = "timestamp_format_example"; # string | A timestamp format
my $compression_codec = "compression_codec_example"; # 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.
my $period = 3600; # int | How frequently log files are finalized so they can be available for reading (in seconds).
my $gzip_level = 0; # int | 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.
my $path = 'null'; # string | The path to upload logs to.
my $account_name = "account_name_example"; # string | The unique Azure Blob Storage namespace in which your data objects are stored. Required.
my $container = "container_example"; # string | The name of the Azure Blob Storage container in which to store logs. Required.
my $sas_token = "sas_token_example"; # 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.
my $public_key = 'null'; # string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk.
my $file_max_bytes = 56; # int | 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). Note that Microsoft Azure Storage has [block size limits](https://learn.microsoft.com/en-us/rest/api/storageservices/put-block?tabs=microsoft-entra-id#remarks).
eval {
    my $result = $api_instance->create_log_azure(service_id => $service_id, version_id => $version_id, name => $name, placement => $placement, response_condition => $response_condition, format => $format, format_version => $format_version, message_type => $message_type, timestamp_format => $timestamp_format, compression_codec => $compression_codec, period => $period, gzip_level => $gzip_level, path => $path, account_name => $account_name, container => $container, sas_token => $sas_token, public_key => $public_key, file_max_bytes => $file_max_bytes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingAzureblobApi->create_log_azure: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. | name | string| The name for the real-time logging configuration. | [optional] 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. | [optional] response_condition | string| The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] format | string| A Fastly log format string. | [optional] [default to '%h %l %u %t "%r" %>s %b'] format_version | int| 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. | [optional] [default to 2] message_type | string| How the message should be formatted. | [optional] [default to 'classic'] timestamp_format | string| A timestamp format | [optional] 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. | [optional] period | int| How frequently log files are finalized so they can be available for reading (in seconds). | [optional] [default to 3600] gzip_level | int| 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. | [optional] [default to 0] path | string| The path to upload logs to. | [optional] [default to 'null'] account_name | string| The unique Azure Blob Storage namespace in which your data objects are stored. Required. | [optional] container | string| The name of the Azure Blob Storage container in which to store logs. Required. | [optional] 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. | [optional] public_key | string| A PGP public key that Fastly will use to encrypt your log files before writing them to disk. | [optional] [default to 'null'] file_max_bytes | int| 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). Note that Microsoft Azure Storage has block size limits. | [optional]

Return type

LoggingAzureblobResponse

Authorization

token

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_log_azure

InlineResponse200 delete_log_azure(service_id => $service_id, version_id => $version_id, logging_azureblob_name => $logging_azureblob_name)

Delete the Azure Blob Storage log endpoint

Delete the Azure Blob Storage logging endpoint for a particular service and version.

Example


            

              
              
use Data::Dumper;
use WebService::Fastly::LoggingAzureblobApi;
my $api_instance = WebService::Fastly::LoggingAzureblobApi->new(
    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_azureblob_name = "logging_azureblob_name_example"; # string | The name for the real-time logging configuration.
eval {
    my $result = $api_instance->delete_log_azure(service_id => $service_id, version_id => $version_id, logging_azureblob_name => $logging_azureblob_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingAzureblobApi->delete_log_azure: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. | logging_azureblob_name | string| The name for the real-time logging configuration. |

Return type

InlineResponse200

Authorization

token

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_log_azure

LoggingAzureblobResponse get_log_azure(service_id => $service_id, version_id => $version_id, logging_azureblob_name => $logging_azureblob_name)

Get an Azure Blob Storage log endpoint

Get the Azure Blob Storage logging endpoint for a particular service and version.

Example


            

              
              
use Data::Dumper;
use WebService::Fastly::LoggingAzureblobApi;
my $api_instance = WebService::Fastly::LoggingAzureblobApi->new(
    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_azureblob_name = "logging_azureblob_name_example"; # string | The name for the real-time logging configuration.
eval {
    my $result = $api_instance->get_log_azure(service_id => $service_id, version_id => $version_id, logging_azureblob_name => $logging_azureblob_name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingAzureblobApi->get_log_azure: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. | logging_azureblob_name | string| The name for the real-time logging configuration. |

Return type

LoggingAzureblobResponse

Authorization

token

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_log_azure

ARRAY[LoggingAzureblobResponse] list_log_azure(service_id => $service_id, version_id => $version_id)

List Azure Blob Storage log endpoints

List all of the Azure Blob Storage logging endpoints for a particular service and version.

Example


            

              
              
use Data::Dumper;
use WebService::Fastly::LoggingAzureblobApi;
my $api_instance = WebService::Fastly::LoggingAzureblobApi->new(
    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
eval {
    my $result = $api_instance->list_log_azure(service_id => $service_id, version_id => $version_id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingAzureblobApi->list_log_azure: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. |

Return type

ARRAY[LoggingAzureblobResponse]

Authorization

token

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_log_azure

LoggingAzureblobResponse update_log_azure(service_id => $service_id, version_id => $version_id, logging_azureblob_name => $logging_azureblob_name, name => $name, placement => $placement, response_condition => $response_condition, format => $format, format_version => $format_version, message_type => $message_type, timestamp_format => $timestamp_format, compression_codec => $compression_codec, period => $period, gzip_level => $gzip_level, path => $path, account_name => $account_name, container => $container, sas_token => $sas_token, public_key => $public_key, file_max_bytes => $file_max_bytes)

Update an Azure Blob Storage log endpoint

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

Example


            

              
              
use Data::Dumper;
use WebService::Fastly::LoggingAzureblobApi;
my $api_instance = WebService::Fastly::LoggingAzureblobApi->new(
    # Configure API key authorization: token
    api_key => {'Fastly-Key' => 'YOUR_API_KEY'},
    # uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    #api_key_prefix => {'Fastly-Key' => 'Bearer'},
);
my $service_id = "service_id_example"; # string | Alphanumeric string identifying the service.
my $version_id = 56; # int | Integer identifying a service version.
my $logging_azureblob_name = "logging_azureblob_name_example"; # string | The name for the real-time logging configuration.
my $name = "name_example"; # string | The name for the real-time logging configuration.
my $placement = "placement_example"; # 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`. 
my $response_condition = "response_condition_example"; # string | The name of an existing condition in the configured endpoint, or leave blank to always execute.
my $format = '%h %l %u %t "%r" %>s %b'; # string | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
my $format_version = 2; # int | 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`. 
my $message_type = 'classic'; # string | How the message should be formatted.
my $timestamp_format = "timestamp_format_example"; # string | A timestamp format
my $compression_codec = "compression_codec_example"; # 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.
my $period = 3600; # int | How frequently log files are finalized so they can be available for reading (in seconds).
my $gzip_level = 0; # int | 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.
my $path = 'null'; # string | The path to upload logs to.
my $account_name = "account_name_example"; # string | The unique Azure Blob Storage namespace in which your data objects are stored. Required.
my $container = "container_example"; # string | The name of the Azure Blob Storage container in which to store logs. Required.
my $sas_token = "sas_token_example"; # 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.
my $public_key = 'null'; # string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk.
my $file_max_bytes = 56; # int | 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). Note that Microsoft Azure Storage has [block size limits](https://learn.microsoft.com/en-us/rest/api/storageservices/put-block?tabs=microsoft-entra-id#remarks).
eval {
    my $result = $api_instance->update_log_azure(service_id => $service_id, version_id => $version_id, logging_azureblob_name => $logging_azureblob_name, name => $name, placement => $placement, response_condition => $response_condition, format => $format, format_version => $format_version, message_type => $message_type, timestamp_format => $timestamp_format, compression_codec => $compression_codec, period => $period, gzip_level => $gzip_level, path => $path, account_name => $account_name, container => $container, sas_token => $sas_token, public_key => $public_key, file_max_bytes => $file_max_bytes);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling LoggingAzureblobApi->update_log_azure: $@\n";
}

Parameters

Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- service_id | string| Alphanumeric string identifying the service. | version_id | int| Integer identifying a service version. | logging_azureblob_name | string| The name for the real-time logging configuration. | name | string| The name for the real-time logging configuration. | [optional] 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. | [optional] response_condition | string| The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] format | string| A Fastly log format string. | [optional] [default to '%h %l %u %t "%r" %>s %b'] format_version | int| 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. | [optional] [default to 2] message_type | string| How the message should be formatted. | [optional] [default to 'classic'] timestamp_format | string| A timestamp format | [optional] 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. | [optional] period | int| How frequently log files are finalized so they can be available for reading (in seconds). | [optional] [default to 3600] gzip_level | int| 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. | [optional] [default to 0] path | string| The path to upload logs to. | [optional] [default to 'null'] account_name | string| The unique Azure Blob Storage namespace in which your data objects are stored. Required. | [optional] container | string| The name of the Azure Blob Storage container in which to store logs. Required. | [optional] 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. | [optional] public_key | string| A PGP public key that Fastly will use to encrypt your log files before writing them to disk. | [optional] [default to 'null'] file_max_bytes | int| 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). Note that Microsoft Azure Storage has block size limits. | [optional]

Return type

LoggingAzureblobResponse

Authorization

token

HTTP request headers

[Back to top] [Back to API list] [Back to Model list] [Back to README]