BlobContainers interface
Интерфейс, представляющий blobContainers.
Методы
| begin |
Эта операция переносит контейнер БОЛЬШИХ двоичных объектов с уровня контейнера WORM на неизменяемый контейнер уровня объекта. Предварительные требования требуют политики неизменяемости уровня контейнера в заблокированном или разблокируемом состоянии, управление версиями на уровне учетной записи должно быть включено, и на контейнере не должно быть удержание по юридическим причинам. |
| begin |
Эта операция переносит контейнер БОЛЬШИХ двоичных объектов с уровня контейнера WORM на неизменяемый контейнер уровня объекта. Предварительные требования требуют политики неизменяемости уровня контейнера в заблокированном или разблокируемом состоянии, управление версиями на уровне учетной записи должно быть включено, и на контейнере не должно быть удержание по юридическим причинам. |
| clear |
Очищает теги юридического удержания. Очистка того же или несуществующего тега приводит к идемпотентной операции. ClearLegalHold очищает только указанные теги в запросе. |
| create(string, string, string, Blob |
Создает контейнер под указанной учетной записью, как описано текстом запроса. Ресурс контейнера содержит метаданные и свойства для этого контейнера. Он не содержит список больших двоичных объектов, содержащихся в контейнере. |
| create |
Создает или обновляет разблокированную политику неизменяемости. ETag в If-Match учитывается, если задано, но не требуется для этой операции. |
| delete(string, string, string, Blob |
Удаляет указанный контейнер в своей учетной записи. |
| delete |
Прерывает разблокированную политику неизменяемости. Ответ удаления имеет неизменяемостьPeriodSinceCreationInDays с значением 0. ETag в If-Match требуется для этой операции. Удаление заблокированной политики неизменяемости запрещено, единственным способом является удаление контейнера после удаления всех просроченных больших двоичных объектов внутри заблокированного контейнера политики. |
| extend |
Расширяет неизменяемостьPeriodSinceCreationInDays заблокированной неизменяемостиPolicy. Единственным действием, разрешенным для заблокированной политики, будет это действие. ETag в If-Match требуется для этой операции. |
| get(string, string, string, Blob |
Возвращает свойства указанного контейнера. |
| get |
Возвращает существующую политику неизменяемости вместе с соответствующим ETag в заголовках ответов и тексте. |
| lease(string, string, string, Blob |
Операция "Контейнер аренды" устанавливает и управляет блокировкой контейнера для операций удаления. Длительность блокировки может составлять от 15 до 60 секунд или может быть бесконечной. |
| list(string, string, Blob |
Выводит список всех контейнеров и не поддерживает префикс, например плоскость данных. Кроме того, SRP сегодня не возвращает маркер продолжения. |
| lock |
Задает для неизменяемостиPolicy состояние "Заблокировано". Единственным действием, разрешенным для заблокированной политики, является действие 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)
Прерывает разблокированную политику неизменяемости. Ответ удаления имеет неизменяемостьPeriodSinceCreationInDays с значением 0. ETag в If-Match требуется для этой операции. Удаление заблокированной политики неизменяемости запрещено, единственным способом является удаление контейнера после удаления всех просроченных больших двоичных объектов внутри заблокированного контейнера политики.
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) политики неизменяемости для обновления должна быть возвращена серверу для всех операций обновления. Значение ETag должно содержать начальные и конечные двойные кавычки, возвращаемые службой.
Параметры параметров.
Возвращаемое значение
extendImmutabilityPolicy(string, string, string, string, BlobContainersExtendImmutabilityPolicyOptionalParams)
Расширяет неизменяемостьPeriodSinceCreationInDays заблокированной неизменяемостиPolicy. Единственным действием, разрешенным для заблокированной политики, будет это действие. 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) политики неизменяемости для обновления должна быть возвращена серверу для всех операций обновления. Значение 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)
Задает для неизменяемостиPolicy состояние "Заблокировано". Единственным действием, разрешенным для заблокированной политики, является действие 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) политики неизменяемости для обновления должна быть возвращена серверу для всех операций обновления. Значение 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>