ContainersOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:containers> attribute.
Constructor
ContainersOperations(*args, **kwargs)
Methods
| begin_create_or_update |
Creates a new container or updates an existing container on the device. Creates a new container or updates an existing container on the device. |
| begin_delete |
Deletes the container on the Data Box Edge/Data Box Gateway device. |
| begin_refresh |
Refreshes the container metadata with the data from the cloud. Refreshes the container metadata with the data from the cloud. |
| get |
Gets a container by name. Gets a container by name. |
| list_by_storage_account |
Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device. Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device. |
begin_create_or_update
Creates a new container or updates an existing container on the device.
Creates a new container or updates an existing container on the device.
async begin_create_or_update(device_name: str, storage_account_name: str, container_name: str, resource_group_name: str, container: _models.Container, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Container]
Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. Required. |
|
storage_account_name
Required
|
The Storage Account Name. Required. |
|
container_name
Required
|
The container name. Required. |
|
resource_group_name
Required
|
The resource group name. Required. |
|
container
Required
|
The container properties. Is either a Container type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either Container or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Deletes the container on the Data Box Edge/Data Box Gateway device.
async begin_delete(device_name: str, storage_account_name: str, container_name: str, resource_group_name: str, **kwargs: Any) -> AsyncLROPoller[None]
Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. Required. |
|
storage_account_name
Required
|
The Storage Account Name. Required. |
|
container_name
Required
|
The container name. Required. |
|
resource_group_name
Required
|
The resource group name. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_refresh
Refreshes the container metadata with the data from the cloud.
Refreshes the container metadata with the data from the cloud.
async begin_refresh(device_name: str, storage_account_name: str, container_name: str, resource_group_name: str, **kwargs: Any) -> AsyncLROPoller[None]
Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. Required. |
|
storage_account_name
Required
|
The Storage Account Name. Required. |
|
container_name
Required
|
The container name. Required. |
|
resource_group_name
Required
|
The resource group name. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of AsyncLROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a container by name.
Gets a container by name.
async get(device_name: str, storage_account_name: str, container_name: str, resource_group_name: str, **kwargs: Any) -> Container
Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. Required. |
|
storage_account_name
Required
|
The Storage Account Name. Required. |
|
container_name
Required
|
The container Name. Required. |
|
resource_group_name
Required
|
The resource group name. Required. |
Returns
| Type | Description |
|---|---|
|
Container or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_by_storage_account
Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.
Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.
list_by_storage_account(device_name: str, storage_account_name: str, resource_group_name: str, **kwargs: Any) -> AsyncIterable[Container]
Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. Required. |
|
storage_account_name
Required
|
The storage Account name. Required. |
|
resource_group_name
Required
|
The resource group name. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either Container or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.databoxedge.v2019_08_01.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv111\\Lib\\site-packages\\azure\\mgmt\\databoxedge\\v2019_08_01\\models\\__init__.py'>