Microsoft Azure
npm i @pi-r/azure
Tip
The alias az can be used in place of “azure” for the service property.
Storage
Interface
interface AzureStorage extends CloudStorage {
service: "azure" | "az";
credential: string | AzureStorageCredential;
bucket: string;
}
interface AzureStorageCredential {
accountName?: string;
accountKey?: string;
accountSas?: string;
connectionString?: string;
sharedAccessSignature?: string;
defaultAzureOptions?: DefaultAzureCredentialOptions;
clientOptions?: StoragePipelineOptions;
}
API
type Metadata = Record<string, string>;
type Tags = Record<string, string>;
Authentication
AZURE_TENANT_ID = "";
AZURE_CLIENT_ID = "";
AZURE_CLIENT_SECRET = "";
/* OR */
AZURE_TENANT_ID = "";
AZURE_CLIENT_ID = "";
AZURE_CLIENT_CERTIFICATE_PATH = "";
AZURE_CLIENT_CERTIFICATE_PASSWORD = ""; // Optional
AZURE_CLIENT_SEND_CERTIFICATE_CHAIN = "";
{
"dataSource": {
"credential": "main", // squared.cloud.json
/* OR */
"credential": {
"accountName": "nodejs",
"accountKey": "**********",
/* OR */
"accountName": "nodejs",
"accountSas": "?sv=2022-11-02&sr=b...",
/* OR */
"connectionString": "DefaultEndpointsProtocol=http;AccountName=nodejs;AccountKey=**********;BlobEndpoint=http://127.0.0.1:10000/nodejs;",
/* OR */
"sharedAccessSignature": "https://nodejs.blob.core.windows.net/bucket?...", // Full URL with SAS token
/* OR */
// DefaultAzureCredential from @azure/identity
}
}
}
AZURE_STORAGE_ACCOUNT = "";
AZURE_STORAGE_KEY = "";
AZURE_STORAGE_CONNECTION_STRING = "";
AZURE_STORAGE_SAS_TOKEN = "";
Note
These are not official Azure environment variables and require process.env.apply = true in squared.json.
Example usage
{
"selector": "html", // Any resource
"cloudStorage": [{
"service": "azure",
"bucket": "nodejs-001",
"credential": {/* Authentication */},
"admin": {
"publicRead": true, // Same as "blob" (access)
/* OR */
"acl": "container",
"emptyBucket": { // azure.listBlobsFlat{ContainerListBlobsOptions}
"recursive": true // Optional
},
"configBucket": {
"website": { // azure.setProperties{staticWebsite}
"indexPage": "index.html", // indexDocument
"indexPath": "home.html", // defaultIndexDocumentPath
"errorPath": "errors/404.html" // errorDocument404Path
},
/* During call to "upload" */
"create": { // azure.create
"access": "container", // Same as "acl"
"metadata": {/* Metadata */}
},
"retentionPolicy": [{ // azure.setAccessPolicy
"id": "policy1",
"accessPolicy": {
"expiresOn": "new Date('2025-01-01')", // Permission "coerce" required when through web service
"permissions": "none",
"startsOn": "new Date('2024-01-01')"
}
}]
}
},
"upload": {
/* Not supported */
"publicRead": false,
"acl": "none",
"options": { // BlockBlobUploadOptions
"blobHTTPHeaders": {
"blobContentType": "text/html"
},
/* All objects except when "metadata" or "tags" is defined */
"metadata": {/* Metadata */},
"tags": {/* Tags */}
},
/* Primary object only */
"metadata": {/* Metadata */},
"tags": {/* Tags */},
/* azure.uploadFile{maxSingleShotSize} */
"chunkSize": "32mb", // Aligned to 1mb
"chunkLimit": 4 // Same as "concurrency"
},
"download": {
/* azure.downloadToFile */
"chunkSize": "2gb", // Set to at least 2gb
"versionId": "2011-03-09T01:42:34.9360000Z", // Alias for "snapshot" (optional)
/* azure.downloadToBuffer{blockSize} */
"chunkSize": "256mb", // Aligned to 1mb
"chunkLimit": 4, // Same as "concurrency"
"options": { // BlobDownloadToBufferOptions
"concurrency": 4
},
"deleteObject": {/* ContainerDeleteMethodOptions */} // azure.delete
}
}]
}
Database
Interface
import type { CosmosClientOptions, FeedOptions, OperationInput, PartitionKey, PatchRequestBody, RequestOptions, SqlQuerySpec } from "@azure/cosmos";
interface AzureDatabaseQuery extends CloudDatabase {
source: "cloud";
service: "azure" | "az";
credential: string | AzureDatabaseCredential;
name: string;
table: string;
query?: string | SqlQuerySpec;
params?: unknown[] | OperationInput[];
partitionKey?: PartitionKey;
options?: FeedOptions | RequestOptions;
update?: PatchRequestBody | Reord<string, unknown>;
storedProcedureId?: string;
}
interface AzureDatabaseCredential extends CosmosClientOptions {
username?: string;
password?: string;
tenantId?: string;
clientId?: string;
}
Authentication
{
"dataSource": {
"credential": "main", // squared.cloud.json
/* OR */
"credential": {
"endpoint": "https://nodejs.documents.azure.com:443",
"key": "**********"
},
/* OR */
"credential": {
"endpoint": "https://nodejs.documents.azure.com:443",
"username": "nodejs", // Azure AD
"password": "**********",
"tenantId": "azure-id", // Optional with AZURE_TENANT_ID
"clientId": "cosmos-id" // Optional with AZURE_CLIENT_ID
}
}
}
AZURE_COSMOS_ENDPOINT = "";
AZURE_COSMOS_KEY = "";
Note
These are not official Azure environment variables and require process.env.apply = true in squared.json.
Example usage
{
"selector": "h1",
"type": "text",
"dataSource": {
"source": "cloud",
"service": "azure",
"credential": {/* Authentication */},
"name": "nodejs", // Database name
"table": "demo",
"id": "1",
"partitionKey": "Pictures", // Optional
"partitionKey": ["Pictures", "Azure"],
"options": {/* RequestOptions */},
/* OR */
"storedProcedureId": "spGetItems",
"params": [1, "value"],
"partitionKey": "Pictures", // Optional
"options": {/* RequestOptions */},
/* OR */
"query": "SELECT * FROM c WHERE c.id = '1'", // Calls "readAll" when not defined
"query": { // SqlQuerySpec
"query": "SELECT * FROM c WHERE c.lastName = @lastName AND c.address.state = @addressState",
"parameters": [
{ "name": "@lastName", "value": "Wakefield" },
{ "name": "@addressState", "value": "CA" }
]
},
"options": {/* FeedOptions */},
"value": "<b>${title}</b>: ${description}",
"update": {/* PatchRequestBody */}, // JSON Patch
"id": "1", // Same as item being retrieved
/* OR */
"query": "SELECT * FROM c WHERE c.id = '1'",
"update": {/* Record<string, unknown> */},
/* WITH */
"partitionKey": "Pictures" // Optional
}
}
@pi-r/azure
Changed in version 0.12.0:
BREAKINGThere is no special handling when uploading the file extension “.map”. CloudStorageUpload property descendantsGroup as [“.map”] can be used to restore the old behavior.
Added in version 0.11.0:
AzureStorage properties upload | download extended CopyObjectAction as copyObject | copyObject[].
Changed in version 0.11.0:
EnvironmentCredential from @azure/identity is enforced when qualified for default authentication.
Added in version 0.10.2:
AzureDatabaseQuery property params as OperationInput[] for use with Bulk Operations API is supported.
Added in version 0.10.0:
AzureStorageCredential property defaultAzureOptions | clientOptions for blob client initialization was implemented.
Cloud instance abort signal is attached to every Cosmos DB SQL query.
Added in version 0.9.0:
AzureStorage property emptyBucket for directory listing as ContainerListBlobsOptions was implemented.
Added in version 0.8.2:
AzureStorageCredential property accountSas for URL authentication using SAS was implemented.
Added in version 0.8.1:
Cosmo DB items method upsert document as Record<string, unknown> was implemented.
Added in version 0.7.0:
CLOUD_UPLOAD_STREAM attribute in ICloudServiceClient was enabled.
CLOUD_UPLOAD_CHUNK attribute in ICloudServiceClient was enabled.
CLOUD_DOWNLOAD_CHUNK attribute in ICloudServiceClient was enabled.
chunkSize | chunkLimit in CloudStorageUpload were implemented.
chunkSize | chunkLimit in CloudStorageDownload were implemented.
Added in version 0.6.2:
Identity authentication with Azure AD (aadCredentials) was implemented.