ContainersOperations Class
ContainersOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectContainersOperations
Constructor
ContainersOperations(client, config, serializer, deserializer)Parameters
| Name | Description |
|---|---|
|
client
Required
|
Client for service requests. |
|
config
Required
|
Configuration of service client. |
|
serializer
Required
|
An object model serializer. |
|
deserializer
Required
|
An object model deserializer. |
Variables
| Name | Description |
|---|---|
|
models
|
Alias to model classes used in this operation group. |
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.
begin_create_or_update(device_name: str, storage_account_name: str, container_name: str, resource_group_name: str, container: '_models.Container', **kwargs: Any) -> LROPoller['_models.Container']Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. |
|
storage_account_name
Required
|
The Storage Account Name. |
|
container_name
Required
|
The container name. |
|
resource_group_name
Required
|
The resource group name. |
|
container
Required
|
The container properties. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller 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.
begin_delete(device_name: str, storage_account_name: str, container_name: str, resource_group_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. |
|
storage_account_name
Required
|
The Storage Account Name. |
|
container_name
Required
|
The container name. |
|
resource_group_name
Required
|
The resource group name. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller 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.
begin_refresh(device_name: str, storage_account_name: str, container_name: str, resource_group_name: str, **kwargs: Any) -> LROPoller[None]Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. |
|
storage_account_name
Required
|
The Storage Account Name. |
|
container_name
Required
|
The container name. |
|
resource_group_name
Required
|
The resource group name. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
Pass in True if you'd like the ARMPolling polling method, False for no polling, or your own initialized polling object for a personal polling strategy. |
|
polling_interval
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Gets a container by name.
Gets a container by name.
get(device_name: str, storage_account_name: str, container_name: str, resource_group_name: str, **kwargs: Any) -> _models.ContainerParameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. |
|
storage_account_name
Required
|
The Storage Account Name. |
|
container_name
Required
|
The container Name. |
|
resource_group_name
Required
|
The resource group name. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
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) -> Iterable['_models.ContainerList']Parameters
| Name | Description |
|---|---|
|
device_name
Required
|
The device name. |
|
storage_account_name
Required
|
The storage Account name. |
|
resource_group_name
Required
|
The resource group name. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either ContainerList or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.databoxedge.v2019_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\databoxedge\\v2019_08_01\\models\\__init__.py'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for