你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

export= module

参考

包:: azure-storage

接口

AccessConditions	如果追加位置等于指定的值。仅适用于追加块操作。有关详细信息，请参阅https://msdn.microsoft.com/en-us/library/mt427365.aspx。
ErrorOrResponse
ErrorOrResult
ServiceResponse
ServiceResult
StorageError
StorageHost

函数

createBlobService()
createBlobService(string)
createBlobService(string, string, string \| StorageHost)	创建新的 BlobService 对象。如果未提供 storageaccount 或 storageaccesskey，则将使用 AZURE_STORAGE_CONNECTION_STRING 和 AZURE_STORAGE_ACCOUNT 和 AZURE_STORAGE_ACCESS_KEY 环境变量。
createBlobServiceAnonymous(string \| StorageHost)	使用主机 URI 和匿名访问创建新的 BlobService 对象。
createBlobServiceWithSas(string \| StorageHost, string)	使用提供的主机 URI 和 SAS 凭据创建新的 BlobService 对象。
createBlobServiceWithTokenCredential(string \| StorageHost, TokenCredential)	使用主机 URI 和提供的 TokenCredential（支持 OAuth）创建新的 BlobService 对象。示例 `var azure = require('azure-storage'); var tokenCredential = new azure.TokenCredential('myOAuthAccessToken'); var blobService = azure.createBlobServiceWithTokenCredential('https://account.blob.core.windows.net', tokenCredential); tokenCredential.set('updatedOAuthAccessToken');`
createFileService()
createFileService(string)
createFileService(string, string, string \| StorageHost)
createFileServiceWithSas(string \| StorageHost, string)	使用提供的主机 URI 和 SAS 凭据创建新的 FileService 对象。
createQueueService()
createQueueService(string)
createQueueService(string, string, string \| StorageHost)	创建新的 QueueService 对象。如果未提供 storageaccount 或 storageaccesskey，则将使用 AZURE_STORAGE_CONNECTION_STRING 和 AZURE_STORAGE_ACCOUNT 和 AZURE_STORAGE_ACCESS_KEY 环境变量。
createQueueServiceWithSas(string \| StorageHost, string)	使用主机 URI 和提供的 SAS 凭据创建新的 QueueService 对象。
createQueueServiceWithTokenCredential(string \| StorageHost, TokenCredential)	使用主机 URI 和提供的 TokenCredential（支持 OAuth）创建新的 QueueService 对象。示例 `var azure = require('azure-storage'); var tokenCredential = new azure.TokenCredential('myOAuthAccessToken'); var queueService = azure.createQueueServiceWithTokenCredential('https://account.queue.core.windows.net', tokenCredential); tokenCredential.set('updatedOAuthAccessToken');`
createTableService()	创建新的 TableService 对象。如果未提供 storageaccount 或 storageaccesskey，则将使用 AZURE_STORAGE_CONNECTION_STRING 和 AZURE_STORAGE_ACCOUNT 和 AZURE_STORAGE_ACCESS_KEY 环境变量。
createTableService(string)
createTableService(string, string, StorageHost)
createTableServiceWithSas(string \| StorageHost, string)	使用主机 URI 和提供的 SAS 凭据创建新的 TableService 对象。
generateAccountSharedAccessSignature(string, string, SharedAccessPolicy)
generateDevelopmentStorageCredentials(string)	创建可用于创建在存储模拟器上运行的服务的连接字符串。必须单独下载模拟器。示例 `var azure = require('azure-storage'); var devStoreCreds = azure.generateDevelopmentStorageCredentials(); var blobService = azure.createBlobService(devStoreCreds);`

函数详细信息

createBlobService()

function createBlobService(): BlobService

azure-storage.export=.services.blob.blobservice.BlobService

createBlobService(string)

function createBlobService(connectionString: string): BlobService

参数

connectionString: string

azure-storage.export=.services.blob.blobservice.BlobService

createBlobService(string, string, string | StorageHost)

创建新的 BlobService 对象。如果未提供 storageaccount 或 storageaccesskey，则将使用 AZURE_STORAGE_CONNECTION_STRING 和 AZURE_STORAGE_ACCOUNT 和 AZURE_STORAGE_ACCESS_KEY 环境变量。

function createBlobService(storageAccount: string, storageAccessKey?: string, host?: string | StorageHost): BlobService

参数

storageAccount: string

storageAccessKey: string

存储访问密钥。

host: string | azure-storage.export=.StorageHost

主机地址。若要仅定义主数据库，请传递字符串。否则，“host.primaryHost”定义主主机，“host.secondaryHost”定义辅助主机。

azure-storage.export=.services.blob.blobservice.BlobService

一个新的 BlobService 对象。

createBlobServiceAnonymous(string | StorageHost)

使用主机 URI 和匿名访问创建新的 BlobService 对象。

function createBlobServiceAnonymous(host?: string | StorageHost): BlobService

参数

host: string | azure-storage.export=.StorageHost

主机地址。若要仅定义主数据库，请传递字符串。否则，“host.primaryHost”定义主主机，“host.secondaryHost”定义辅助主机。

azure-storage.export=.services.blob.blobservice.BlobService

具有匿名凭据的新 BlobService 对象。

createBlobServiceWithSas(string | StorageHost, string)

使用提供的主机 URI 和 SAS 凭据创建新的 BlobService 对象。

function createBlobServiceWithSas(host: string | StorageHost, sasToken: string): BlobService

参数

host: string | azure-storage.export=.StorageHost

主机地址。若要仅定义主数据库，请传递字符串。否则，“host.primaryHost”定义主主机，“host.secondaryHost”定义辅助主机。

sasToken: string

共享访问签名令牌。

azure-storage.export=.services.blob.blobservice.BlobService

具有 SAS 凭据的新 BlobService 对象。

createBlobServiceWithTokenCredential(string | StorageHost, TokenCredential)

使用主机 URI 和提供的 TokenCredential（支持 OAuth）创建新的 BlobService 对象。

示例

var azure = require('azure-storage');
var tokenCredential = new azure.TokenCredential('myOAuthAccessToken');
var blobService = azure.createBlobServiceWithTokenCredential('https://account.blob.core.windows.net', tokenCredential);
tokenCredential.set('updatedOAuthAccessToken');

function createBlobServiceWithTokenCredential(host: string | StorageHost, token: TokenCredential): BlobService

参数

host: string | azure-storage.export=.StorageHost

主机地址。若要仅定义主数据库，请传递字符串。否则，“host.primaryHost”定义主主机，“host.secondaryHost”定义辅助主机。

token: azure-storage.export=.common.models.tokenCredential.TokenCredential

TokenCredential 对象。

azure-storage.export=.services.blob.blobservice.BlobService

具有 TokenCredential 凭据的新 BlobService 对象。

createFileService()

function createFileService(): FileService

FileService

createFileService(string)

function createFileService(connectionString: string): FileService

参数

connectionString: string

FileService

createFileService(string, string, string | StorageHost)

function createFileService(storageAccount: string, storageAccessKey: string, host?: string | StorageHost): FileService

参数

storageAccount: string

storageAccessKey: string

host: string | azure-storage.export=.StorageHost

FileService

createFileServiceWithSas(string | StorageHost, string)

使用提供的主机 URI 和 SAS 凭据创建新的 FileService 对象。

function createFileServiceWithSas(hostUri: string | StorageHost, sasToken: string): FileService

参数

hostUri: string | azure-storage.export=.StorageHost

sasToken: string

共享访问签名令牌。

FileService

具有 SAS 凭据的新 FileService 对象。

createQueueService()

function createQueueService(): QueueService

azure-storage.export=.services.queue.QueueService

createQueueService(string)

function createQueueService(connectionString: string): QueueService

参数

connectionString: string

azure-storage.export=.services.queue.QueueService

createQueueService(string, string, string | StorageHost)

创建新的 QueueService 对象。如果未提供 storageaccount 或 storageaccesskey，则将使用 AZURE_STORAGE_CONNECTION_STRING 和 AZURE_STORAGE_ACCOUNT 和 AZURE_STORAGE_ACCESS_KEY 环境变量。

function createQueueService(storageAccount: string, storageAccessKey?: string, host?: string | StorageHost): QueueService

参数

storageAccount: string

storageAccessKey: string

存储访问密钥。

host: string | azure-storage.export=.StorageHost

主机地址。若要仅定义主数据库，请传递字符串。否则，“host.primaryHost”定义主主机，“host.secondaryHost”定义辅助主机。

azure-storage.export=.services.queue.QueueService

一个新的 QueueService 对象。

createQueueServiceWithSas(string | StorageHost, string)

使用主机 URI 和提供的 SAS 凭据创建新的 QueueService 对象。

function createQueueServiceWithSas(host: string | StorageHost, sasToken: string): QueueService

参数

host: string | azure-storage.export=.StorageHost

主机地址。若要仅定义主数据库，请传递字符串。否则，“host.primaryHost”定义主主机，“host.secondaryHost”定义辅助主机。

sasToken: string

共享访问签名令牌。

azure-storage.export=.services.queue.QueueService

具有 SAS 凭据的新 QueueService 对象。

createQueueServiceWithTokenCredential(string | StorageHost, TokenCredential)

使用主机 URI 和提供的 TokenCredential（支持 OAuth）创建新的 QueueService 对象。

示例

var azure = require('azure-storage');
var tokenCredential = new azure.TokenCredential('myOAuthAccessToken');
var queueService = azure.createQueueServiceWithTokenCredential('https://account.queue.core.windows.net', tokenCredential);
tokenCredential.set('updatedOAuthAccessToken');

function createQueueServiceWithTokenCredential(host: string | StorageHost, token: TokenCredential): QueueService

参数

host: string | azure-storage.export=.StorageHost

主机地址。若要仅定义主数据库，请传递字符串。否则，“host.primaryHost”定义主主机，“host.secondaryHost”定义辅助主机。

token: azure-storage.export=.common.models.tokenCredential.TokenCredential

TokenCredential 对象。

azure-storage.export=.services.queue.QueueService

具有 TokenCredential 对象的新 QueueService 对象。

createTableService()

创建新的 TableService 对象。如果未提供 storageaccount 或 storageaccesskey，则将使用 AZURE_STORAGE_CONNECTION_STRING 和 AZURE_STORAGE_ACCOUNT 和 AZURE_STORAGE_ACCESS_KEY 环境变量。

function createTableService(): TableService

TableService

新的 TableService 对象。

createTableService(string)

function createTableService(connectionString: string): TableService

参数

connectionString: string

TableService

createTableService(string, string, StorageHost)

function createTableService(storageAccountOrConnectionString: string, storageAccessKey: string, host?: StorageHost): TableService

参数

storageAccountOrConnectionString: string

storageAccessKey: string

host: azure-storage.export=.StorageHost

TableService

createTableServiceWithSas(string | StorageHost, string)

使用主机 URI 和提供的 SAS 凭据创建新的 TableService 对象。

function createTableServiceWithSas(hostUri: string | StorageHost, sasToken: string): TableService

参数

hostUri: string | azure-storage.export=.StorageHost

sasToken: string

共享访问签名令牌。

TableService

具有 SAS 凭据的新 TableService 对象。

generateAccountSharedAccessSignature(string, string, SharedAccessPolicy)

function generateAccountSharedAccessSignature(storageAccountOrConnectionString: string, storageAccessKey: string, sharedAccessAccountPolicy: SharedAccessPolicy): string

参数

storageAccountOrConnectionString: string

storageAccessKey: string

sharedAccessAccountPolicy: azure-storage.export=.common.SharedAccessPolicy

string

generateDevelopmentStorageCredentials(string)

创建可用于创建在存储模拟器上运行的服务的连接字符串。必须单独下载模拟器。

示例

var azure = require('azure-storage');
var devStoreCreds = azure.generateDevelopmentStorageCredentials();
var blobService = azure.createBlobService(devStoreCreds);

function generateDevelopmentStorageCredentials(proxyUri?: string): string

参数

proxyUri: string

proxyUri。默认为 http://127.0.0.1

string

表示开发存储凭据的连接字符串。

通过

export= module

接口

函数

函数详细信息

createBlobService()

返回

createBlobService(string)

参数

返回

createBlobService(string, string, string | StorageHost)

参数

返回

createBlobServiceAnonymous(string | StorageHost)

参数

返回

createBlobServiceWithSas(string | StorageHost, string)

参数

返回

createBlobServiceWithTokenCredential(string | StorageHost, TokenCredential)

参数

返回

createFileService()

返回

createFileService(string)

参数

返回

createFileService(string, string, string | StorageHost)

参数

返回

createFileServiceWithSas(string | StorageHost, string)

参数

返回

createQueueService()

返回

createQueueService(string)

参数

返回

createQueueService(string, string, string | StorageHost)

参数

返回

createQueueServiceWithSas(string | StorageHost, string)

参数

返回

createQueueServiceWithTokenCredential(string | StorageHost, TokenCredential)

参数

返回

createTableService()

返回

createTableService(string)

参数

返回

createTableService(string, string, StorageHost)

参数

返回

createTableServiceWithSas(string | StorageHost, string)

参数

返回

generateAccountSharedAccessSignature(string, string, SharedAccessPolicy)

参数

返回

generateDevelopmentStorageCredentials(string)

参数

返回

其他资源