BlobContainers interface
Интерфейс, представляющий BlobContainers.
Методы
| begin |
Эта операция переносит контейнер больших двоичных объектов из WORM на уровне контейнера в контейнер с поддержкой неизменяемости на уровне объекта. Для выполнения предварительных требований требуется политика неизменяемости на уровне контейнера в заблокированном или незаблокированном состоянии. Управление версиями на уровне учетной записи должно быть включено, а удержание по юридическим причинам в контейнере не должно быть. |
| begin |
Эта операция переносит контейнер больших двоичных объектов из WORM на уровне контейнера в контейнер с поддержкой неизменяемости на уровне объекта. Для выполнения предварительных требований требуется политика неизменяемости на уровне контейнера в заблокированном или незаблокированном состоянии. Управление версиями на уровне учетной записи должно быть включено, а удержание по юридическим причинам в контейнере не должно быть. |
| clear |
Очищает юридические теги удержания. Очистка того же или несуществующего тега приводит к идемпотентной операции. ClearLegalHold очищает только указанные теги в запросе. |
| create(string, string, string, Blob |
Создает новый контейнер в указанной учетной записи, как описано в тексте запроса. Ресурс контейнера содержит метаданные и свойства для данного контейнера. Ресурс не включает список больших двоичных объектов, которые содержит контейнер. |
| create |
Создает или обновляет разблокированную политику неизменяемости. ETag в If-Match учитывается, если он задан, но не требуется для этой операции. |
| delete(string, string, string, Blob |
Удаляет указанный контейнер из своей учетной записи. |
| delete |
Отменяет разблокированную политику неизменяемости. В ответе на удаление параметру immutabilityPeriodSinceCreationInDays задано значение 0. Для этой операции требуется ETag в If-Match. Удаление заблокированной политики неизменяемости запрещено. Единственный способ — удалить контейнер после удаления всех просроченных BLOB-объектов в контейнере, заблокированном политикой. |
| extend |
Расширяет неизменяемостьPeriodSinceCreationInDays заблокированной политики неизменяемости. Единственное действие, разрешенное для заблокированной политики, — это действие. Для этой операции требуется ETag в If-Match. |
| get(string, string, string, Blob |
Возвращает свойства указанного контейнера. |
| get |
Возвращает существующую политику неизменяемости вместе с соответствующим ETag в заголовках и тексте ответа. |
| lease(string, string, string, Blob |
Операция "Контейнер аренды" устанавливает блокировку контейнера для операций удаления и управляет им. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной. |
| list(string, string, Blob |
Выводит список всех контейнеров и не поддерживает префикс, например плоскость данных. Кроме того, SRP сегодня не возвращает маркер продолжения. |
| lock |
Устанавливает для параметра ImmutabilityPolicy значение Заблокировано. Единственным действием, разрешенным для заблокированной политики, является действие ExtendImmutabilityPolicy. Для этой операции требуется ETag в If-Match. |
| set |
Задает теги удержания по юридическим причинам. Установка того же тега приводит к идемпотентной операции. SetLegalHold следует шаблону добавления и не очищает существующие теги, которые не указаны в запросе. |
| update(string, string, string, Blob |
Обновления свойства контейнера, как указано в тексте запроса. Свойства, не указанные в запросе, останутся неизменными. Обновление завершается ошибкой, если указанный контейнер еще не существует. |
Сведения о методе
beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)
Эта операция переносит контейнер больших двоичных объектов из WORM на уровне контейнера в контейнер с поддержкой неизменяемости на уровне объекта. Для выполнения предварительных требований требуется политика неизменяемости на уровне контейнера в заблокированном или незаблокированном состоянии. Управление версиями на уровне учетной записи должно быть включено, а удержание по юридическим причинам в контейнере не должно быть.
function beginObjectLevelWorm(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
Параметры параметров.
Возвращаемое значение
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)
Эта операция переносит контейнер больших двоичных объектов из WORM на уровне контейнера в контейнер с поддержкой неизменяемости на уровне объекта. Для выполнения предварительных требований требуется политика неизменяемости на уровне контейнера в заблокированном или незаблокированном состоянии. Управление версиями на уровне учетной записи должно быть включено, а удержание по юридическим причинам в контейнере не должно быть.
function beginObjectLevelWormAndWait(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
Параметры параметров.
Возвращаемое значение
Promise<void>
clearLegalHold(string, string, string, LegalHold, BlobContainersClearLegalHoldOptionalParams)
Очищает юридические теги удержания. Очистка того же или несуществующего тега приводит к идемпотентной операции. ClearLegalHold очищает только указанные теги в запросе.
function clearLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams): Promise<LegalHold>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- legalHold
- LegalHold
Свойство LegalHold, которое будет удалено из контейнера BLOB-объектов.
Параметры параметров.
Возвращаемое значение
Promise<LegalHold>
create(string, string, string, BlobContainer, BlobContainersCreateOptionalParams)
Создает новый контейнер в указанной учетной записи, как описано в тексте запроса. Ресурс контейнера содержит метаданные и свойства для данного контейнера. Ресурс не включает список больших двоичных объектов, которые содержит контейнер.
function create(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams): Promise<BlobContainer>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- blobContainer
- BlobContainer
Свойства создаваемого контейнера BLOB-объектов.
Параметры параметров.
Возвращаемое значение
Promise<BlobContainer>
createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)
Создает или обновляет разблокированную политику неизменяемости. ETag в If-Match учитывается, если он задан, но не требуется для этой операции.
function createOrUpdateImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams): Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
Параметры параметров.
Возвращаемое значение
delete(string, string, string, BlobContainersDeleteOptionalParams)
Удаляет указанный контейнер из своей учетной записи.
function delete(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams): Promise<void>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
Параметры параметров.
Возвращаемое значение
Promise<void>
deleteImmutabilityPolicy(string, string, string, string, BlobContainersDeleteImmutabilityPolicyOptionalParams)
Отменяет разблокированную политику неизменяемости. В ответе на удаление параметру immutabilityPeriodSinceCreationInDays задано значение 0. Для этой операции требуется ETag в If-Match. Удаление заблокированной политики неизменяемости запрещено. Единственный способ — удалить контейнер после удаления всех просроченных BLOB-объектов в контейнере, заблокированном политикой.
function deleteImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams): Promise<BlobContainersDeleteImmutabilityPolicyResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- ifMatch
-
string
Версия состояния сущности (ETag) политики неизменяемости для обновления. Значение "*" можно использовать для применения операции, только если политика неизменяемости уже существует. Если этот параметр опущен, эта операция будет применяться всегда.
Параметры параметров.
Возвращаемое значение
extendImmutabilityPolicy(string, string, string, string, BlobContainersExtendImmutabilityPolicyOptionalParams)
Расширяет неизменяемостьPeriodSinceCreationInDays заблокированной политики неизменяемости. Единственное действие, разрешенное для заблокированной политики, — это действие. Для этой операции требуется ETag в If-Match.
function extendImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams): Promise<BlobContainersExtendImmutabilityPolicyResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- ifMatch
-
string
Версия состояния сущности (ETag) политики неизменяемости для обновления. Значение "*" можно использовать для применения операции, только если политика неизменяемости уже существует. Если этот параметр опущен, эта операция будет применяться всегда.
Параметры параметров.
Возвращаемое значение
get(string, string, string, BlobContainersGetOptionalParams)
Возвращает свойства указанного контейнера.
function get(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams): Promise<BlobContainer>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- options
- BlobContainersGetOptionalParams
Параметры параметров.
Возвращаемое значение
Promise<BlobContainer>
getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)
Возвращает существующую политику неизменяемости вместе с соответствующим ETag в заголовках и тексте ответа.
function getImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams): Promise<BlobContainersGetImmutabilityPolicyResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
Параметры параметров.
Возвращаемое значение
lease(string, string, string, BlobContainersLeaseOptionalParams)
Операция "Контейнер аренды" устанавливает блокировку контейнера для операций удаления и управляет им. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной.
function lease(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams): Promise<LeaseContainerResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
Параметры параметров.
Возвращаемое значение
Promise<LeaseContainerResponse>
list(string, string, BlobContainersListOptionalParams)
Выводит список всех контейнеров и не поддерживает префикс, например плоскость данных. Кроме того, SRP сегодня не возвращает маркер продолжения.
function list(resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams): PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- options
- BlobContainersListOptionalParams
Параметры параметров.
Возвращаемое значение
lockImmutabilityPolicy(string, string, string, string, BlobContainersLockImmutabilityPolicyOptionalParams)
Устанавливает для параметра ImmutabilityPolicy значение Заблокировано. Единственным действием, разрешенным для заблокированной политики, является действие ExtendImmutabilityPolicy. Для этой операции требуется ETag в If-Match.
function lockImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams): Promise<BlobContainersLockImmutabilityPolicyResponse>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- ifMatch
-
string
Версия состояния сущности (ETag) обновляемой политики неизменяемости. Значение "*" можно использовать для применения операции только в том случае, если политика неизменяемости уже существует. Если этот параметр опущен, эта операция будет применяться всегда.
Параметры параметров.
Возвращаемое значение
setLegalHold(string, string, string, LegalHold, BlobContainersSetLegalHoldOptionalParams)
Задает теги удержания по юридическим причинам. Установка того же тега приводит к идемпотентной операции. SetLegalHold следует шаблону добавления и не очищает существующие теги, которые не указаны в запросе.
function setLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams): Promise<LegalHold>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- legalHold
- LegalHold
Свойство LegalHold, которое будет присвоено контейнеру BLOB-объектов.
Параметры параметров.
Возвращаемое значение
Promise<LegalHold>
update(string, string, string, BlobContainer, BlobContainersUpdateOptionalParams)
Обновления свойства контейнера, как указано в тексте запроса. Свойства, не указанные в запросе, останутся неизменными. Обновление завершается ошибкой, если указанный контейнер еще не существует.
function update(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams): Promise<BlobContainer>Параметры
- resourceGroupName
-
string
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается.
- accountName
-
string
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра.
- containerName
-
string
Имя контейнера BLOB-объектов в указанной учетной записи хранения. Имена контейнеров BLOB-объектов должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра.
- blobContainer
- BlobContainer
Свойства, обновляемые для контейнера BLOB-объектов.
Параметры параметров.
Возвращаемое значение
Promise<BlobContainer>