Interface AzureStorageNodeParameters

Source
interface AzureStorageNodeParameters {
    authentication?: "oAuth2" | "sharedKey";
    binaryPropertyName?: string;
    blob?: { mode: "id" | "list"; value: string };
    blobCreate?: string;
    container?: { mode: "id" | "list"; value: string };
    containerCreate?: string;
    from?: "url" | "binary";
    limit?: number;
    operation?: "create" | "get" | "getAll" | "delete";
    options?:
        | {
            accessTier?: "Archive"
            | "Cold"
            | "Cool"
            | "Hot";
            blobType?: "BlockBlob" | "PageBlob" | "AppendBlob";
            cacheControl?: string;
            contentCrc64?: string;
            contentEncoding?: string;
            contentLanguage?: string;
            contentMd5?: string;
            contentType?: string;
            encryptionContext?: string;
            encryptionScope?: string;
            expiryOption?: "Absolute" | "NeverExpire";
            expiryTime?: string;
            filename?: string;
            immutabilityPolicyMode?: string;
            immutabilityPolicyUntilDate?: string;
            leaseId?: string;
            legalHold?: boolean;
            metadata?: {
                metadataValues: {
                    fieldName?: string;
                    fieldValue?: string;
                }[];
            };
            origin?: string;
            tags?: {
                tagValues: {
                    tagName?: string;
                    tagValue?: string;
                }[];
            };
        }
        | { leaseId?: string }
        | {
            leaseId?: string;
            origin?: string;
            simplify?: boolean;
            upn?: boolean;
        }
        | {
            fields?: (
                | "copy"
                | "deleted"
                | "deletedwithversions"
                | "immutabilitypolicy"
                | "legalhold"
                | "metadata"
                | "permissions"
                | "snapshots"
                | "tags"
                | "uncommittedblobs"
                | "versions"
            )[];
            filter?: ("deleted" | "files" | "directories")[];
            simplify?: boolean;
            upn?: boolean;
        }
        | {
            accessLevel?: ""
            | "container"
            | "blob";
            metadata?: {
                metadataValues: {
                    fieldName?: string;
                    fieldValue?: string;
                }[];
            };
        }
        | { simplify?: boolean }
        | {
            fields?: ("system" | "deleted" | "metadata")[];
            filter?: string;
        };
    resource?: "container"
    | "blob";
    returnAll?: boolean;
    url?: string;
}

Properties§

Source§

readonly authentication?: "oAuth2" | "sharedKey"

Default: "sharedKey"

Source§

readonly binaryPropertyName?: string

The name of the input binary field containing the file to be written Default: "data"

Source§

readonly blob?: { mode: "id" | "list"; value: string }

Blob to be deleted Default: {"mode":"list","value":""}

Source§

readonly blobCreate?: string

The name of the new or existing blob

Source§

readonly container?: { mode: "id" | "list"; value: string }

Container to create or replace a blob in Default: {"mode":"list","value":""}

Source§

readonly containerCreate?: string

The name of the new container

Source§

readonly from?: "url" | "binary"

Default: "binary"

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

Source§

readonly operation?: "create" | "get" | "getAll" | "delete"

Default: "getAll"

Source§

readonly options?:
    | {
        accessTier?: "Archive"
        | "Cold"
        | "Cool"
        | "Hot";
        blobType?: "BlockBlob" | "PageBlob" | "AppendBlob";
        cacheControl?: string;
        contentCrc64?: string;
        contentEncoding?: string;
        contentLanguage?: string;
        contentMd5?: string;
        contentType?: string;
        encryptionContext?: string;
        encryptionScope?: string;
        expiryOption?: "Absolute" | "NeverExpire";
        expiryTime?: string;
        filename?: string;
        immutabilityPolicyMode?: string;
        immutabilityPolicyUntilDate?: string;
        leaseId?: string;
        legalHold?: boolean;
        metadata?: {
            metadataValues: {
                fieldName?: string;
                fieldValue?: string;
            }[];
        };
        origin?: string;
        tags?: {
            tagValues: { tagName?: string; tagValue?: string }[];
        };
    }
    | { leaseId?: string }
    | {
        leaseId?: string;
        origin?: string;
        simplify?: boolean;
        upn?: boolean;
    }
    | {
        fields?: (
            | "copy"
            | "deleted"
            | "deletedwithversions"
            | "immutabilitypolicy"
            | "legalhold"
            | "metadata"
            | "permissions"
            | "snapshots"
            | "tags"
            | "uncommittedblobs"
            | "versions"
        )[];
        filter?: ("deleted" | "files" | "directories")[];
        simplify?: boolean;
        upn?: boolean;
    }
    | {
        accessLevel?: ""
        | "container"
        | "blob";
        metadata?: {
            metadataValues: {
                fieldName?: string;
                fieldValue?: string;
            }[];
        };
    }
    | { simplify?: boolean }
    | {
        fields?: ("system" | "deleted" | "metadata")[];
        filter?: string;
    }

Default: {}

Source§

readonly resource?: "container" | "blob"

Default: "container"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly url?: string

URL where to read of the blob contents from