@azure/storage-blob package
Классы
AccountSASPermissions |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей разрешения, предоставляемые AccountSAS. Значение true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений они должны быть сериализованы с помощью toString и заданы в качестве поля разрешений для объекта AccountSASSignatureValues . Можно создать строку разрешений и без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность. |
AccountSASResourceTypes |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей ресурсы, доступные для AccountSAS. Значение true означает, что любой SAS, использующий эти разрешения, предоставит доступ к этому типу ресурса. После установки всех значений они должны быть сериализованы с помощью toString и заданы в качестве поля ресурсов в объекте AccountSASSignatureValues . Можно создать строку ресурсов и без этого класса, но порядок ресурсов является конкретным, и этот класс гарантирует правильность. |
AccountSASServices |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей службы, доступные для AccountSAS. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит доступ к этой службе. После установки всех значений они должны быть сериализованы с помощью toString и заданы в качестве поля служб в объекте AccountSASSignatureValues . Можно создать строку служб и без этого класса, но порядок служб является конкретным, и этот класс гарантирует правильность. |
AnonymousCredential |
AnonymousCredential предоставляет член credentialPolicyCreator, используемый для создания объектов AnonymousCredentialPolicy. AnonymousCredentialPolicy используется с HTTP-запросами, которые считывают общедоступные ресурсы, или для использования с подписанными URL-адресами (SAS). |
AnonymousCredentialPolicy |
AnonymousCredentialPolicy используется с HTTP-запросами, которые считывают общедоступные ресурсы, или для использования с подписанными URL-адресами (SAS). |
AppendBlobClient |
AppendBlobClient определяет набор операций, применимых к добавлению BLOB-объектов. |
BaseRequestPolicy |
Базовый класс, от которого наследуются все политики запросов. |
BlobBatch |
BlobBatch представляет агрегированный набор операций с большими двоичными объектами.
В настоящее время поддерживаются только |
BlobBatchClient |
BlobBatchClient позволяет выполнять пакетные запросы к службе BLOB-объектов службы хранилища Azure. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch |
BlobClient |
BlobClient представляет URL-адрес большого двоичного объекта службы хранилища Azure; Blob может быть блочный BLOB-объект, добавочный BLOB-объект или страничный BLOB-объект. |
BlobLeaseClient |
Клиент, который управляет арендой ContainerClient или BlobClient. |
BlobSASPermissions |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS большому двоичному объекту. Значение true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений они должны быть сериализованы с помощью toString и заданы в качестве поля разрешений для объекта BlobSASSignatureValues . Можно создать строку разрешений и без этого класса, но порядок разрешений является конкретным, и этот класс гарантирует правильность. |
BlobServiceClient |
BlobServiceClient представляет клиент для службы BLOB-объектов службы хранилища Azure, что позволяет управлять контейнерами BLOB-объектов. |
BlockBlobClient |
BlockBlobClient определяет набор операций, применимых к блочных BLOB-объектам. |
ContainerClient |
ContainerClient представляет URL-адрес контейнера службы хранилища Azure, позволяющий управлять его BLOB-объектами. |
ContainerSASPermissions |
Это вспомогательный класс для создания строки, представляющей разрешения, предоставленные ServiceSAS контейнеру. Установка значения true означает, что любой SAS, использующий эти разрешения, предоставит разрешения для этой операции. После установки всех значений его следует сериализовать с помощью toString и задать в качестве поля разрешений для объекта BlobSASSignatureValues . Можно создать строку разрешений и без этого класса, но порядок разрешений конкретный, и этот класс гарантирует правильность. |
Credential |
Credential — это абстрактный класс для подписывания HTTP-запросов службы хранилища Azure. Этот класс будет размещать фабрику credentialPolicyCreator, которая создает CredentialPolicy. |
CredentialPolicy |
Политика учетных данных, используемая для подписывания ЗАПРОСОВ HTTP(S) перед отправкой. Этот класс является абстрактным. |
HttpHeaders |
Коллекция пар "ключ-значение" заголовка HTTP. |
PageBlobClient |
PageBlobClient определяет набор операций, применимых к страничные BLOB-объекты. |
Pipeline |
Класс Pipeline, содержащий политики HTTP-запросов. Вы можете создать конвейер по умолчанию, вызвав newPipeline. Вы также можете создать конвейер с собственными политиками с помощью конструктора Конвейера. Перед реализацией настраиваемого конвейера ознакомьтесь с разделом newPipeline и предоставленными политиками. |
RequestPolicyOptions |
Необязательные свойства, которые можно использовать при создании RequestPolicy. |
RestError |
Ошибка, возникающая в результате HTTP-запроса к конечной точке службы. |
SASQueryParameters |
Представляет компоненты, составляющие параметры запроса SAS службы хранилища Azure. Этот тип не создается непосредственно пользователем; он создается только типами AccountSASSignatureValues и BlobSASSignatureValues . После создания его можно закодировать в toString() и добавить к URL-адресу напрямую (хотя здесь следует соблюдать осторожность, если существуют параметры запроса, которые могут повлиять на соответствующие способы добавления этих параметров запроса). ПРИМЕЧАНИЕ. Экземпляры этого класса являются неизменяемыми. |
StorageBrowserPolicy |
StorageBrowserPolicy обрабатывает различия между Node.js и средой выполнения браузера, в том числе:
|
StorageBrowserPolicyFactory |
StorageBrowserPolicyFactory — это класс фабрики, помогающий создавать объекты StorageBrowserPolicy. |
StorageRetryPolicy |
Политика повторных попыток с экспоненциальной повторными попытками и линейными повторными попытками. |
StorageRetryPolicyFactory |
StorageRetryPolicyFactory — это класс фабрики, помогающий создавать объекты StorageRetryPolicy . |
StorageSharedKeyCredential |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. StorageSharedKeyCredential для авторизации ключа учетной записи службы хранилища Azure. |
StorageSharedKeyCredentialPolicy |
StorageSharedKeyCredentialPolicy — это политика, используемая для подписывания HTTP-запроса с помощью общего ключа. |
WebResource |
Создает новый объект WebResource. Этот класс обеспечивает абстракцию при вызове REST, не зависят от библиотеки или реализации и упаковывает необходимые свойства для запуска запроса. |
Интерфейсы
AccessPolicy |
Политика доступа |
AccountSASPermissionsLike |
Тип, который выглядит как разрешение SAS учетной записи. Используется в AccountSASPermissions для анализа разрешений SAS от необработанных объектов. |
AccountSASSignatureValues |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. AccountSASSignatureValues используется для создания подписанного URL-адреса (SAS) для учетной записи хранения Azure. После правильного задания всех значений вызовите метод generateAccountSASQueryParameters , чтобы получить представление SAS, которое фактически можно применить к URL-адресам blob-объектов. Обратите внимание, что и этот класс, и SASQueryParameters существуют, так как первый является изменяемым и логическим представлением, а второй является неизменяемым и используется для создания фактических запросов REST. Дополнительные https://docs.microsoft.com/en-us/azure/storage/common/storage-dotnet-shared-access-signature-part-1 сведения о SAS см https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas . в описании параметров, включая необходимые. |
AppendBlobAppendBlockFromURLOptions |
Параметры для настройки операции appendBlockFromURL . |
AppendBlobAppendBlockFromUrlHeaders |
Определяет заголовки для операции AppendBlob_appendBlockFromUrl. |
AppendBlobAppendBlockHeaders |
Определяет заголовки для операции AppendBlob_appendBlock. |
AppendBlobAppendBlockOptions |
Параметры для настройки операции appendBlock . |
AppendBlobCreateHeaders |
Определяет заголовки для операции AppendBlob_create. |
AppendBlobCreateIfNotExistsOptions |
Параметры для настройки операции createIfNotExists . |
AppendBlobCreateIfNotExistsResponse |
Содержит данные ответа для <xref:appendBlobClient.createIfNotExists> операции. |
AppendBlobCreateOptions |
Параметры для настройки операции создания . |
AppendBlobRequestConditions |
Условия для добавления к созданию этого добавочного BLOB-объекта. |
AppendBlobSealOptions |
Параметры для настройки операции запечатывания . |
AppendPositionAccessConditions |
Группа параметров |
BatchSubRequest |
Запрос, связанный с пакетной операцией. |
BatchSubResponse |
Данные ответа, связанные с одним запросом в пакетной операции. |
BlobAbortCopyFromURLHeaders |
Определяет заголовки для операции Blob_abortCopyFromURL. |
BlobAbortCopyFromURLOptions |
Параметры для настройки операции abortCopyFromURL . |
BlobAcquireLeaseOptions |
Параметры для настройки операции "Большой двоичный объект — получение аренды". |
BlobBatchSubmitBatchOptionalParams |
Параметры для настройки службы — отправка пакетной службы необязательные параметры. |
BlobBeginCopyFromURLOptions |
Параметры для настройки операции beginCopyFromURL . |
BlobBeginCopyFromURLResponse |
Содержит данные ответа для операции beginCopyFromURL . |
BlobBeginCopyFromUrlPollState |
Состояние, используемое опрашителем, возвращенное из beginCopyFromURL. Это состояние передается в обратный вызов, заданный |
BlobBreakLeaseOptions |
Параметры для настройки операции "Большой двоичный объект — прерывание аренды". |
BlobChangeLeaseOptions |
Параметры для настройки операции "Большой двоичный объект — изменение аренды". |
BlobCopyFromURLHeaders |
Определяет заголовки для операции Blob_copyFromURL. |
BlobCreateSnapshotHeaders |
Определяет заголовки для операции Blob_createSnapshot. |
BlobCreateSnapshotOptions |
Параметры для настройки операции createSnapshot . |
BlobDeleteHeaders |
Определяет заголовки для операции Blob_delete. |
BlobDeleteIfExistsResponse |
Содержит данные ответа для операции deleteIfExists . |
BlobDeleteImmutabilityPolicyHeaders |
Определяет заголовки для операции Blob_deleteImmutabilityPolicy. |
BlobDeleteImmutabilityPolicyOptions |
Параметры удаления политики неизменяемости deleteImmutabilityPolicy operation. |
BlobDeleteOptions |
Параметры для настройки операции удаления . |
BlobDownloadHeaders |
Определяет заголовки для операции Blob_download. |
BlobDownloadOptionalParams |
Дополнительные параметры. |
BlobDownloadOptions |
Параметры для настройки операции скачивания . |
BlobDownloadResponseParsed |
Содержит данные ответа для операции скачивания . |
BlobDownloadToBufferOptions |
Интерфейс option для операции downloadToBuffer . |
BlobExistsOptions |
Параметры для настройки операции существует . |
BlobFlatListSegment |
Интерфейс, представляющий BlobFlatListSegment. |
BlobFlatListSegmentModel | |
BlobGenerateSasUrlOptions |
Параметры для настройки операции generateSasUrl . |
BlobGetPropertiesHeaders |
Определяет заголовки для операции Blob_getProperties. |
BlobGetPropertiesOptions |
Параметры для настройки операции getProperties . |
BlobGetPropertiesResponse |
Содержит данные ответа для операции getProperties . |
BlobGetTagsHeaders |
Определяет заголовки для операции Blob_getTags. |
BlobGetTagsOptions |
Параметры для настройки операции getTags . |
BlobHTTPHeaders |
Группа параметров |
BlobHierarchyListSegment |
Интерфейс, представляющий BlobHierarchyListSegment. |
BlobHierarchyListSegmentModel | |
BlobImmutabilityPolicy |
Описывать неизменяемую политику для BLOB-объекта. |
BlobItem |
Большой двоичный объект службы хранилища Azure |
BlobItemInternal |
Большой двоичный объект службы хранилища Azure |
BlobPrefix | |
BlobProperties |
Свойства большого двоичного объекта |
BlobQueryArrowConfiguration |
Параметры для запроса большого двоичного объекта в формате Apache Arrow. Допустимо только для outputTextConfiguration. |
BlobQueryArrowField |
Описать поле в BlobQueryArrowConfiguration. |
BlobQueryCsvTextConfiguration |
Параметры для запроса большого двоичного объекта в формате CSV. |
BlobQueryError |
Тип ошибки запроса BLOB-объектов. |
BlobQueryHeaders |
Определяет заголовки для операции Blob_query. |
BlobQueryJsonTextConfiguration |
Параметры для запроса большого двоичного объекта в формате JSON. |
BlobQueryParquetConfiguration |
Параметры для запроса большого двоичного объекта в формате Parquet. Допустимо только для inputTextConfiguration. |
BlobReleaseLeaseOptions |
Параметры для настройки операции аренды BLOB-объектов. |
BlobRenewLeaseOptions |
Параметры для настройки операции "Большой двоичный объект — продление аренды". |
BlobRequestConditions |
стандартные условные заголовки HTTP, условие тегов и условие аренды |
BlobSASPermissionsLike |
Тип, который выглядит как разрешение SAS для BLOB-объектов. Используется в BlobSASPermissions для анализа разрешений SAS от необработанных объектов. |
BlobSASSignatureValues |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. BlobSASSignatureValues используется для создания маркеров SAS службы BLOB-объектов для контейнеров или BLOB-объектов. |
BlobServiceProperties |
Свойства службы хранилища. |
BlobServiceStatistics |
Статистика для службы хранилища. |
BlobSetHTTPHeadersHeaders |
Определяет заголовки для операции Blob_setHttpHeaders. |
BlobSetHTTPHeadersOptions |
Параметры для настройки операции setHTTPHeaders . |
BlobSetImmutabilityPolicyHeaders |
Определяет заголовки для операции Blob_setImmutabilityPolicy. |
BlobSetImmutabilityPolicyOptions |
Параметры настройки политики неизменяемости setImmutabilityPolicy operation. |
BlobSetLegalHoldHeaders |
Определяет заголовки для операции Blob_setLegalHold. |
BlobSetLegalHoldOptions |
Параметры для настройки юридического набора удержанийОперацияLegalHold . |
BlobSetMetadataHeaders |
Определяет заголовки для операции Blob_setMetadata. |
BlobSetMetadataOptions |
Параметры для настройки операции setMetadata . |
BlobSetTagsHeaders |
Определяет заголовки для операции Blob_setTags. |
BlobSetTagsOptions |
Параметры для настройки операции setTags . |
BlobSetTierHeaders |
Определяет заголовки для операции Blob_setTier. |
BlobSetTierOptions |
Параметры для настройки операции setAccessTier . |
BlobStartCopyFromURLHeaders |
Определяет заголовки для операции Blob_startCopyFromURL. |
BlobStartCopyFromURLOptions |
Параметры для настройки операции beginCopyFromURL . |
BlobSyncCopyFromURLOptions |
Параметры для настройки операции syncCopyFromURL . |
BlobTag | |
BlobTags |
Теги BLOB-объектов |
BlobUndeleteHeaders |
Определяет заголовки для операции Blob_undelete. |
BlobUndeleteOptions |
Параметры для настройки операции отмены удаления. |
Block |
Представляет один блок в блочном BLOB-объекте. Он описывает идентификатор и размер блока. |
BlockBlobCommitBlockListHeaders |
Определяет заголовки для операции BlockBlob_commitBlockList. |
BlockBlobCommitBlockListOptions |
Параметры для настройки операции commitBlockList . |
BlockBlobGetBlockListHeaders |
Определяет заголовки для операции BlockBlob_getBlockList. |
BlockBlobGetBlockListOptions |
Параметры для настройки операции getBlockList . |
BlockBlobParallelUploadOptions |
Интерфейс параметров для uploadFile и <xref:BlockBlobClient.uploadSeekableStream>. |
BlockBlobPutBlobFromUrlHeaders |
Определяет заголовки для операции BlockBlob_putBlobFromUrl. |
BlockBlobQueryOptions |
Параметры для настройки операции запроса . |
BlockBlobStageBlockFromURLHeaders |
Определяет заголовки для операции BlockBlob_stageBlockFromURL. |
BlockBlobStageBlockFromURLOptions |
Параметры для настройки операции stageBlockFromURL . |
BlockBlobStageBlockHeaders |
Определяет заголовки для операции BlockBlob_stageBlock. |
BlockBlobStageBlockOptions |
Параметры для настройки операции stageBlock . |
BlockBlobSyncUploadFromURLOptions |
Параметры для настройки операции syncUploadFromURL . |
BlockBlobUploadHeaders |
Определяет заголовки для операции BlockBlob_upload. |
BlockBlobUploadOptions |
Параметры для настройки операции отправки . |
BlockBlobUploadStreamOptions |
Интерфейс параметров для операции uploadStream . |
BlockList | |
CommonGenerateSasUrlOptions |
Общие параметры BlobGenerateSasUrlOptions и ContainerGenerateSasUrlOptions. |
CommonOptions |
Интерфейс для параметров, общих для каждой удаленной операции. |
ContainerAcquireLeaseOptions |
Параметры для настройки операции "Контейнер — получение аренды". |
ContainerBreakLeaseOptionalParams |
Дополнительные параметры. |
ContainerBreakLeaseOptions |
Параметры для настройки операции "Контейнер — прерывание аренды". |
ContainerChangeLeaseOptions |
Параметры для настройки операции "Контейнер — изменение аренды". |
ContainerCreateHeaders |
Определяет заголовки для операции Container_create. |
ContainerCreateIfNotExistsResponse |
Содержит данные ответа для операции createIfNotExists . |
ContainerCreateOptions |
Параметры для настройки операции создания . |
ContainerDeleteBlobOptions |
Параметры для настройки операции deleteBlob . |
ContainerDeleteHeaders |
Определяет заголовки для операции Container_delete. |
ContainerDeleteIfExistsResponse |
Содержит данные ответа для операции deleteIfExists . |
ContainerDeleteMethodOptions |
Параметры для настройки операции удаления . |
ContainerEncryptionScope |
Группа параметров |
ContainerExistsOptions |
Параметры для настройки операции exists . |
ContainerFilterBlobsHeaders |
Определяет заголовки для операции Container_filterBlobs. |
ContainerFindBlobByTagsOptions |
Параметры для настройки операции findBlobsByTags . |
ContainerGenerateSasUrlOptions |
Параметры для настройки операции generateSasUrl . |
ContainerGetAccessPolicyHeaders |
Определяет заголовки для операции Container_getAccessPolicy. |
ContainerGetAccessPolicyOptions |
Параметры для настройки операции getAccessPolicy . |
ContainerGetPropertiesHeaders |
Определяет заголовки для операции Container_getProperties. |
ContainerGetPropertiesOptions |
Параметры для настройки операции getProperties . |
ContainerItem |
Контейнер службы хранилища Azure |
ContainerListBlobFlatSegmentHeaders |
Определяет заголовки для операции Container_listBlobFlatSegment. |
ContainerListBlobHierarchySegmentHeaders |
Определяет заголовки для операции Container_listBlobHierarchySegment. |
ContainerListBlobsOptions |
Параметры для настройки операций контейнера — перечисления BLOB-объектов. См. |
ContainerProperties |
Свойства контейнера |
ContainerReleaseLeaseOptions |
Параметры для настройки операции аренды контейнера — выпуска. |
ContainerRenameHeaders |
Определяет заголовки для операции Container_rename. |
ContainerRenewLeaseOptions |
Параметры для настройки операции "Контейнер — продление аренды". |
ContainerRequestConditions |
Условия для контейнера. |
ContainerSASPermissionsLike |
Тип, который выглядит как разрешение SAS контейнера. Используется в ContainerSASPermissions для анализа разрешений SAS из необработанных объектов. |
ContainerSetAccessPolicyHeaders |
Определяет заголовки для операции Container_setAccessPolicy. |
ContainerSetAccessPolicyOptions |
Параметры для настройки операции setAccessPolicy . |
ContainerSetMetadataHeaders |
Определяет заголовки для операции Container_setMetadata. |
ContainerSetMetadataOptions |
Параметры для настройки операции setMetadata . |
ContainerUndeleteHeaders |
Определяет заголовки для операции Container_restore. |
CorsRule |
CORS является функцией HTTP, которая позволяет веб-приложению, работающему в одном домене, обращаться к ресурсам из другого домена. Веб-браузеры реализуют ограничение безопасности, известное как политика одного источника, которое запрещает веб-странице вызывать API в другом домене; CORS предоставляет безопасный способ разрешить одному домену (исходному домену) вызывать API в другом домене. |
CpkInfo |
Группа параметров |
FilterBlobItem |
Сведения о большом двоичном объекте из findBlobsByTags |
FilterBlobItemModel |
Сведения о BLOB-объекте из вызова API фильтрации BLOB-объектов |
FilterBlobSegment |
Ответ сегмента операции findBlobsByTags . |
FilterBlobSegmentModel |
Результат вызова API фильтруемых BLOB-объектов |
GeoReplication |
Geo-Replication сведения о вторичной службе хранилища |
HttpAuthorization |
Представляет сведения проверке подлинности в значениях заголовков Authorization, ProxyAuthorization, WWW-Authneticate и Proxy-Authenticate. |
HttpOperationResponse |
Объект-оболочка для HTTP-запроса и ответа. Десериализованный объект хранится в свойстве |
IHttpClient |
Интерфейс, который может отправлять запросы HttpRequest и получать обещанные httpResponses. |
Lease |
Сведения о конкретной аренде. |
LeaseAccessConditions |
Группа параметров |
LeaseOperationOptions |
Настраивает операции аренды. |
ListBlobsFlatSegmentResponse |
Перечисление больших двоичных объектов |
ListBlobsFlatSegmentResponseModel |
Перечисление больших двоичных объектов |
ListBlobsHierarchySegmentResponse |
Перечисление больших двоичных объектов |
ListBlobsHierarchySegmentResponseModel |
Перечисление больших двоичных объектов |
ListContainersSegmentResponse |
Перечисление контейнеров |
Logging |
Параметры ведения журнала Azure Analytics. |
MatchConditions |
Задает параметры HTTP для условных запросов на основе сопоставления ETag. |
Metadata |
Сопоставление пар "имя-значение", которые необходимо связать с ресурсом. |
Metrics |
сводка статистики запросов, сгруппированных по API в статистических выражениях по часам или минутам для больших двоичных объектов |
ModificationConditions |
Задает параметры HTTP для условных запросов на основе времени изменения. |
ModifiedAccessConditions |
стандартное условие условных заголовков и тегов HTTP. |
ModifiedAccessConditionsModel |
Группа параметров |
ObjectReplicationPolicy |
Содержит идентификатор политики репликации объектов и соответствующий список ObjectReplicationRule. Используется при получении свойств репликации объектов в исходном BLOB-объекте. Идентификатор политики для целевого BLOB-объекта задается в ObjectReplicationDestinationPolicyId соответствующих ответов метода (например <xref:BlobProperties.ObjectReplicationDestinationPolicyId>, . |
ObjectReplicationRule |
Содержит идентификатор правила репликации объектов и ObjectReplicationStatus большого двоичного объекта. Объект ObjectReplicationPolicy может содержать несколько объектов ObjectReplicationRule. |
PageBlobClearPagesHeaders |
Определяет заголовки для операции PageBlob_clearPages. |
PageBlobClearPagesOptions |
Параметры для настройки операции clearPages . |
PageBlobCopyIncrementalHeaders |
Определяет заголовки для операции PageBlob_copyIncremental. |
PageBlobCreateHeaders |
Определяет заголовки для операции PageBlob_create. |
PageBlobCreateIfNotExistsOptions |
Параметры для настройки операции createIfNotExists . |
PageBlobCreateIfNotExistsResponse |
Содержит данные ответа для операции createIfNotExists . |
PageBlobCreateOptions |
Параметры для настройки операции создания . |
PageBlobGetPageRangesDiffHeaders |
Определяет заголовки для операции PageBlob_getPageRangesDiff. |
PageBlobGetPageRangesDiffOptions |
Параметры для настройки <xref:PageBlobClient.getRangesDiff> операции. |
PageBlobGetPageRangesDiffResponse |
Содержит данные ответа для getPageRangesDiff(number, number, string, PageBlobGetPageRangesDiffOptions) операции. |
PageBlobGetPageRangesHeaders |
Определяет заголовки для операции PageBlob_getPageRanges. |
PageBlobGetPageRangesOptions |
Параметры для настройки операции getPageRanges . |
PageBlobGetPageRangesResponse |
Содержит данные ответа для getPageRanges(number, number, PageBlobGetPageRangesOptions) операции. |
PageBlobListPageRangesDiffOptions |
Параметры для настройки операции listPageRangesDiff . |
PageBlobListPageRangesOptions |
Параметры для настройки операции listPageRanges . |
PageBlobRequestConditions |
Условия для добавления к созданию этого страничного BLOB-объекта. |
PageBlobResizeHeaders |
Определяет заголовки для операции PageBlob_resize. |
PageBlobResizeOptions |
Параметры для настройки операции изменения размера . |
PageBlobStartCopyIncrementalOptions |
Параметры для настройки операции startCopyIncremental . |
PageBlobUpdateSequenceNumberHeaders |
Определяет заголовки для операции PageBlob_updateSequenceNumber. |
PageBlobUpdateSequenceNumberOptions |
Параметры для настройки операции updateSequenceNumber . |
PageBlobUploadPagesFromURLHeaders |
Определяет заголовки для операции PageBlob_uploadPagesFromURL. |
PageBlobUploadPagesFromURLOptions |
Параметры для настройки операции uploadPagesFromURL . |
PageBlobUploadPagesHeaders |
Определяет заголовки для операции PageBlob_uploadPages. |
PageBlobUploadPagesOptions |
Параметры для настройки операции uploadPages . |
PageList |
Список диапазонов страниц для BLOB-объекта. |
PageRangeInfo | |
ParsedBatchResponse |
Многокомпонентный или смешанный ответ, содержащий ответ для каждого вложенного запроса. |
PipelineLike |
Интерфейс для класса Pipeline , содержащего политики HTTP-запросов. Вы можете создать конвейер по умолчанию, вызвав newPipeline. Вы также можете создать конвейер с собственными политиками с помощью конструктора Конвейера. Перед реализацией настраиваемого конвейера ознакомьтесь с разделом newPipeline и предоставленными политиками. |
PipelineOptions |
Интерфейс параметров для конструктора конвейера. |
PollOperationState |
PollOperationState содержит список с наименьшим набором свойств, необходимых для определения любого длительно выполняющегося опрашителя операций. Хотя класс Poller работает в качестве локального механизма управления для запуска, ожидания и, возможно, отмены длительной операции, PollOperationState документирует состояние удаленной длительной операции. Его следует обновлять по крайней мере при запуске операции, после ее завершения и при отмене операции. Однако реализации могут иметь любое другое количество свойств, которые могут быть обновлены по другим причинам. |
PollerLike |
Абстрактное представление средства опроса, предназначенного для предоставления только минимального API, с которым должен работать пользователь. |
PollerLikeWithCancellation |
Абстрактное представление средства опроса, предназначенного для предоставления только минимального API, с которым должен работать пользователь. |
Range |
Диапазон для операций службы BLOB-объектов. |
RequestPolicy |
Базовая структура политики запросов. |
RetentionPolicy |
политика хранения, которая определяет, как долго должны сохраняться связанные данные; |
SASQueryParametersOptions |
Параметры для создания SASQueryParameters. |
SasIPRange |
Допустимый диапазон IP-адресов для SAS. |
SequenceNumberAccessConditions |
Группа параметров |
ServiceFilterBlobsHeaders |
Определяет заголовки для операции Service_filterBlobs. |
ServiceFindBlobByTagsOptions |
Параметры для настройки операции findBlobsByTags . |
ServiceGenerateAccountSasUrlOptions |
Параметры для настройки операции generateAccountSasUrl . |
ServiceGetAccountInfoHeaders |
Определяет заголовки для операции Service_getAccountInfo. |
ServiceGetAccountInfoOptions |
Параметры для настройки операции getAccountInfo . |
ServiceGetPropertiesHeaders |
Определяет заголовки для операции Service_getProperties. |
ServiceGetPropertiesOptions |
Параметры для настройки операции getProperties . |
ServiceGetStatisticsHeaders |
Определяет заголовки для операции Service_getStatistics. |
ServiceGetStatisticsOptions |
Параметры для настройки операции getStatistics . |
ServiceGetUserDelegationKeyHeaders |
Определяет заголовки для операции Service_getUserDelegationKey. |
ServiceGetUserDelegationKeyOptions |
Параметры для настройки службы — получение ключа делегирования пользователя. |
ServiceListContainersOptions |
Параметры для настройки операции listContainers . |
ServiceListContainersSegmentHeaders |
Определяет заголовки для операции Service_listContainersSegment. |
ServiceRenameContainerOptions |
Параметры для настройки <xref:BlobServiceClient.renameContainer> операции. |
ServiceSetPropertiesHeaders |
Определяет заголовки для операции Service_setProperties. |
ServiceSetPropertiesOptions |
Параметры для настройки операции setProperties . |
ServiceSubmitBatchHeaders |
Определяет заголовки для операции Service_submitBatch. |
ServiceSubmitBatchOptionalParamsModel |
Дополнительные параметры. |
ServiceUndeleteContainerOptions |
Параметры для настройки операции undeleteContainer . |
SignedIdentifier |
Подписанный идентификатор. |
SignedIdentifierModel |
подписанный идентификатор |
StaticWebsite |
Свойства, позволяющие учетной записи размещать статический веб-сайт |
StoragePipelineOptions |
Интерфейс параметров для функции newPipeline . |
StorageRetryOptions |
Интерфейс параметров повтора blob-объектов хранилища. |
TagConditions |
Задает параметры HTTP для условных запросов на основе тегов BLOB-объектов. |
UserDelegationKey |
Ключ делегирования пользователя. |
UserDelegationKeyModel |
Ключ делегирования пользователя |
Псевдонимы типа
AccessTier |
Определяет значения для AccessTier. |
AccountKind |
Определяет значения для AccountKind. |
AppendBlobAppendBlockFromUrlResponse |
Содержит данные ответа для операции appendBlockFromUrl. |
AppendBlobAppendBlockResponse |
Содержит данные ответа для операции appendBlock. |
AppendBlobCreateResponse |
Содержит данные ответа для операции создания. |
ArchiveStatus |
Определяет значения для ArchiveStatus. |
BlobAbortCopyFromURLResponse |
Содержит данные ответа для операции abortCopyFromURL. |
BlobBatchDeleteBlobsResponse |
Содержит данные ответа для deleteBlobs(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, BlobDeleteOptions) операции. |
BlobBatchSetBlobsAccessTierResponse |
Содержит данные ответа для setBlobsAccessTier(string[], StorageSharedKeyCredential | AnonymousCredential | TokenCredential, AccessTier, BlobSetTierOptions) операции. |
BlobBatchSubmitBatchResponse |
Содержит данные ответа для пакетных операций с большими двоичными объектами. |
BlobCopyFromURLResponse |
Содержит данные ответа для операции copyFromURL. |
BlobCopySourceTags |
Определяет значения для BlobCopySourceTags. |
BlobCreateSnapshotResponse |
Содержит данные ответа для операции createSnapshot. |
BlobDeleteImmutabilityPolicyResponse |
Содержит данные ответа для операции deleteImmutabilityPolicy. |
BlobDeleteResponse |
Содержит данные ответа для операции удаления. |
BlobDownloadResponseModel |
Содержит данные ответа для операции скачивания. |
BlobGetPropertiesResponseModel |
Содержит данные ответа для операции getProperties. |
BlobGetTagsResponse |
Содержит данные ответа для операции getTags . |
BlobImmutabilityPolicyMode |
Определяет значения для BlobImmutabilityPolicyMode. |
BlobQueryArrowFieldType |
Тип BlobQueryArrowField. |
BlobQueryResponseModel |
Содержит данные ответа для операции запроса. |
BlobSetHTTPHeadersResponse |
Содержит данные ответа для операции setHttpHeaders. |
BlobSetImmutabilityPolicyResponse |
Содержит данные ответа для операции setImmutabilityPolicy. |
BlobSetLegalHoldResponse |
Содержит данные ответа для операции setLegalHold. |
BlobSetMetadataResponse |
Содержит данные ответа для операции setMetadata. |
BlobSetTagsResponse |
Содержит данные ответа для операции setTags. |
BlobSetTierResponse |
Содержит данные ответа для операции setTier. |
BlobStartCopyFromURLResponse |
Содержит данные ответа для операции startCopyFromURL. |
BlobType |
Определяет значения для BlobType. |
BlobUndeleteResponse |
Содержит данные ответа для операции отмены удаления. |
BlobUploadCommonResponse |
Тип ответа для uploadFile, uploadStream и <xref:BlockBlobClient.uploadBrowserDate>. |
BlockBlobCommitBlockListResponse |
Содержит данные ответа для операции commitBlockList. |
BlockBlobGetBlockListResponse |
Содержит данные ответа для операции getBlockList. |
BlockBlobPutBlobFromUrlResponse |
Содержит данные ответа для операции putBlobFromUrl. |
BlockBlobStageBlockFromURLResponse |
Содержит данные ответа для операции stageBlockFromURL. |
BlockBlobStageBlockResponse |
Содержит данные ответа для операции stageBlock. |
BlockBlobUploadResponse |
Содержит данные ответа для операции отправки. |
BlockListType |
Определяет значения для BlockListType. |
ContainerCreateResponse |
Содержит данные ответа для операции создания. |
ContainerDeleteResponse |
Содержит данные ответа для операции удаления. |
ContainerFindBlobsByTagsSegmentResponse |
Ответ операции findBlobsByTags . |
ContainerGetAccessPolicyResponse |
Содержит данные ответа для операции getAccessPolicy . |
ContainerGetPropertiesResponse |
Содержит данные ответа для операции getProperties. |
ContainerListBlobFlatSegmentResponse |
Содержит данные ответа для операции listBlobFlatSegment. |
ContainerListBlobHierarchySegmentResponse |
Содержит данные ответа для операции listBlobHierarchySegment. |
ContainerRenameResponse |
Содержит данные ответа для операции переименования. |
ContainerSetAccessPolicyResponse |
Содержит данные ответа для операции setAccessPolicy. |
ContainerSetMetadataResponse |
Содержит данные ответа для операции setMetadata. |
ContainerUndeleteResponse |
Содержит данные ответа для операции восстановления. |
CopyPollerBlobClient |
Определяет операции из BlobClient , необходимые для работы опрашителя, возвращаемого методом beginCopyFromURL . |
CopyStatusType |
Определяет значения для CopyStatusType. |
CredentialPolicyCreator |
Фабричные функции, создающие новую credentialPolicy, которая использует предоставленную функцию nextPolicy. |
DeleteSnapshotsOptionType |
Определяет значения для DeleteSnapshotsOptionType. |
EncryptionAlgorithmType |
Определяет значения для EncryptionAlgorithmType. Сведения о значениях, поддерживаемых службойAES256 |
GeoReplicationStatusType |
Определяет значения для GeoReplicationStatusType. |
HttpRequestBody |
Возможные типы текста HTTP-запроса |
LeaseDurationType |
Определяет значения для LeaseDurationType. |
LeaseOperationResponse |
Содержит данные ответа для операций, которые создают, изменяют или удаляют аренду. |
LeaseStateType |
Определяет значения для LeaseStateType. |
LeaseStatusType |
Определяет значения для LeaseStatusType. |
ObjectReplicationStatus |
Указывает состояние репликации большого двоичного объекта. Используется, когда к учетной записи хранения применяются политики репликации объектов. См . Статьи ObjectReplicationPolicy и ObjectReplicationRule. |
PageBlobClearPagesResponse |
Содержит данные ответа для операции clearPages. |
PageBlobCopyIncrementalResponse |
Содержит данные ответа для операции copyIncremental. |
PageBlobCreateResponse |
Содержит данные ответа для операции создания. |
PageBlobGetPageRangesDiffResponseModel |
Содержит данные ответа для операции getPageRangesDiff. |
PageBlobGetPageRangesResponseModel |
Содержит данные ответа для операции getPageRanges. |
PageBlobResizeResponse |
Содержит данные ответа для операции изменения размера. |
PageBlobUpdateSequenceNumberResponse |
Содержит данные ответа для операции updateSequenceNumber. |
PageBlobUploadPagesFromURLResponse |
Содержит данные ответа для операции uploadPagesFromURL. |
PageBlobUploadPagesResponse |
Содержит данные ответа для операции uploadPages. |
PublicAccessType |
Определяет значения для PublicAccessType. |
RehydratePriority |
Определяет значения rehydratePriority. |
RequestPolicyFactory |
Создает новый объект RequestPolicy для каждого запроса, использующего предоставленную функцию nextPolicy. |
SequenceNumberActionType |
Определяет значения для SequenceNumberActionType. |
ServiceFindBlobsByTagsSegmentResponse |
Ответ операции findBlobsByTags . |
ServiceGetAccountInfoResponse |
Содержит данные ответа для операции getAccountInfo. |
ServiceGetPropertiesResponse |
Содержит данные ответа для операции getProperties. |
ServiceGetStatisticsResponse |
Содержит данные ответа для операции getStatistics. |
ServiceGetUserDelegationKeyResponse |
Содержит данные ответа для getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions) операции. |
ServiceListContainersSegmentResponse |
Содержит данные ответа для операции listContainersSegment. |
ServiceSetPropertiesResponse |
Содержит данные ответа для операции setProperties. |
ServiceSubmitBatchResponseModel |
Содержит данные ответа для операции submitBatch. |
SkuName |
Определяет значения для SkuName. |
SyncCopyStatusType |
Определяет значения для SyncCopyStatusType. |
Tags |
Теги BLOB-объектов. |
Перечисления
BlockBlobTier |
Представляет уровень доступа к большому двоичному объекту. Подробные сведения об уровне блочных BLOB-объектов см. в разделе Горячий, холодный и архивный уровни хранилища. |
KnownEncryptionAlgorithmType |
Известные значения EncryptionAlgorithmType , которые принимает служба. |
PremiumPageBlobTier |
Указывает уровень страничного BLOB-объекта, на который следует задать большой двоичный объект. Это применимо только к страничные BLOB-объекты в учетных записях хранения класса Premium. Подробные сведения о соответствующих операций ввода-вывода в секунду и пропускной способности для PageBlobTier см. здесь . |
SASProtocol |
Протоколы для созданного SAS. |
StorageBlobAudience |
Определяет известные облачные аудитории для службы хранилища. |
StorageRetryPolicyType |
Типы RetryPolicy. |
Функции
deserialization |
Создайте новый объект сериализации RequestPolicyCreator, который будет сериализовать тела HTTP-запросов по мере их прохождения через конвейер HTTP. |
generate |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает объект SASQueryParameters , содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST. См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas |
generate |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает экземпляр SASQueryParameters. Принимает только необходимые параметры, необходимые для создания SAS. Для необязательных параметров задайте соответствующие свойства напрямую, например разрешения, startsOn и идентификатор. ПРЕДУПРЕЖДЕНИЕ. Если идентификатор не указан, требуются разрешения и срок действия. Необходимо назначить значение идентификатору или истекаетВ & разрешений вручную, если вы инициалируете с этим конструктором. Перед выполнением следующих фрагментов введите необходимые сведения. Пример использования:
Пример использования идентификатора:
Пример использования имени большого двоичного объекта:
|
generate |
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS. Создает экземпляр SASQueryParameters. ПРЕДУПРЕЖДЕНИЕ. Идентификатор будет игнорироваться при создании SAS для делегирования пользователя, требуются разрешения и срок действия. Пример использования:
|
get |
|
is |
Вспомогательная функция для определения того, удовлетворяет ли данный аргумент контракту конвейера |
new |
Создает новый объект Pipeline с предоставленными учетными данными. |
Сведения о функции
deserializationPolicy(DeserializationContentTypes, SerializerOptions)
Создайте новый объект сериализации RequestPolicyCreator, который будет сериализовать тела HTTP-запросов по мере их прохождения через конвейер HTTP.
function deserializationPolicy(deserializationContentTypes?: DeserializationContentTypes, parsingOptions?: SerializerOptions): RequestPolicyFactory
Параметры
- deserializationContentTypes
- DeserializationContentTypes
- parsingOptions
- SerializerOptions
Возвращаемое значение
generateAccountSASQueryParameters(AccountSASSignatureValues, StorageSharedKeyCredential)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Создает объект SASQueryParameters , содержащий все параметры запроса SAS, необходимые для выполнения фактического запроса REST.
См. раздел https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
function generateAccountSASQueryParameters(accountSASSignatureValues: AccountSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
Параметры
- accountSASSignatureValues
- AccountSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Возвращаемое значение
generateBlobSASQueryParameters(BlobSASSignatureValues, StorageSharedKeyCredential)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Создает экземпляр SASQueryParameters.
Принимает только необходимые параметры, необходимые для создания SAS. Для необязательных параметров задайте соответствующие свойства напрямую, например разрешения, startsOn и идентификатор.
ПРЕДУПРЕЖДЕНИЕ. Если идентификатор не указан, требуются разрешения и срок действия. Необходимо назначить значение идентификатору или истекаетВ & разрешений вручную, если вы инициалируете с этим конструктором.
Перед выполнением следующих фрагментов введите необходимые сведения.
Пример использования:
// Generate service level SAS for a container
const containerSAS = generateBlobSASQueryParameters({
containerName, // Required
permissions: ContainerSASPermissions.parse("racwdl"), // Required
startsOn: new Date(), // Optional
expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2016-05-31" // Optional
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
Пример использования идентификатора:
// Generate service level SAS for a container with identifier
// startsOn & permissions are optional when identifier is provided
const identifier = "unique-id";
await containerClient.setAccessPolicy(undefined, [
{
accessPolicy: {
expiresOn: new Date(new Date().valueOf() + 86400), // Date type
permissions: ContainerSASPermissions.parse("racwdl").toString(),
startsOn: new Date() // Date type
},
id: identifier
}
]);
const containerSAS = generateBlobSASQueryParameters(
{
containerName, // Required
identifier // Required
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
Пример использования имени большого двоичного объекта:
// Generate service level SAS for a blob
const blobSAS = generateBlobSASQueryParameters({
containerName, // Required
blobName, // Required
permissions: BlobSASPermissions.parse("racwd"), // Required
startsOn: new Date(), // Optional
expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
cacheControl: "cache-control-override", // Optional
contentDisposition: "content-disposition-override", // Optional
contentEncoding: "content-encoding-override", // Optional
contentLanguage: "content-language-override", // Optional
contentType: "content-type-override", // Optional
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2016-05-31" // Optional
},
sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters
Параметры
- blobSASSignatureValues
- BlobSASSignatureValues
- sharedKeyCredential
- StorageSharedKeyCredential
Возвращаемое значение
generateBlobSASQueryParameters(BlobSASSignatureValues, UserDelegationKey, string)
ДОСТУПНО ТОЛЬКО В СРЕДЕ ВЫПОЛНЕНИЯ NODE.JS.
Создает экземпляр SASQueryParameters. ПРЕДУПРЕЖДЕНИЕ. Идентификатор будет игнорироваться при создании SAS для делегирования пользователя, требуются разрешения и срок действия.
Пример использования:
// Generate user delegation SAS for a container
const userDelegationKey = await blobServiceClient.getUserDelegationKey(startsOn, expiresOn);
const containerSAS = generateBlobSASQueryParameters({
containerName, // Required
permissions: ContainerSASPermissions.parse("racwdl"), // Required
startsOn, // Optional. Date type
expiresOn, // Required. Date type
ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
protocol: SASProtocol.HttpsAndHttp, // Optional
version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
},
userDelegationKey, // UserDelegationKey
accountName
).toString();
function generateBlobSASQueryParameters(blobSASSignatureValues: BlobSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters
Параметры
- blobSASSignatureValues
- BlobSASSignatureValues
- userDelegationKey
- UserDelegationKey
Возвращаемое значение blobServiceClient.getUserDelegationKey()
- accountName
-
string
Возвращаемое значение
getBlobServiceAccountAudience(string)
function getBlobServiceAccountAudience(storageAccountName: string): string
Параметры
- storageAccountName
-
string
Возвращаемое значение
string
isPipelineLike(unknown)
Вспомогательная функция для определения того, удовлетворяет ли данный аргумент контракту конвейера
function isPipelineLike(pipeline: unknown): pipeline
Параметры
- pipeline
-
unknown
Аргумент, который может быть конвейером
Возвращаемое значение
pipeline
True, если аргумент удовлетворяет контракту конвейера
newPipeline(StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
Создает новый объект Pipeline с предоставленными учетными данными.
function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline
Параметры
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
Например, AnonymousCredential, StorageSharedKeyCredential или любые учетные @azure/identity
данные из пакета для проверки подлинности запросов к службе. Можно также предоставить объект, реализующий интерфейс TokenCredential. Если не указано, используется AnonymousCredential.
- pipelineOptions
- StoragePipelineOptions
Необязательный элемент. Параметры.
Возвращаемое значение
Новый объект Pipeline.