Containers interface
Interface representing a Containers.
Methods
Method Details
beginCreateOrUpdate(string, string, string, string, Container, ContainersCreateOrUpdateOptionalParams)
Creates a new container or updates an existing container on the device.
function beginCreateOrUpdate(deviceName: string, storageAccountName: string, containerName: string, resourceGroupName: string, container: Container, options?: ContainersCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<Container>, Container>>Parameters
- deviceName
-
string
The device name.
- storageAccountName
-
string
The Storage Account Name
- containerName
-
string
The container name.
- resourceGroupName
-
string
The resource group name.
- container
- Container
The container properties.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<Container>, Container>>
beginCreateOrUpdateAndWait(string, string, string, string, Container, ContainersCreateOrUpdateOptionalParams)
Creates a new container or updates an existing container on the device.
function beginCreateOrUpdateAndWait(deviceName: string, storageAccountName: string, containerName: string, resourceGroupName: string, container: Container, options?: ContainersCreateOrUpdateOptionalParams): Promise<Container>Parameters
- deviceName
-
string
The device name.
- storageAccountName
-
string
The Storage Account Name
- containerName
-
string
The container name.
- resourceGroupName
-
string
The resource group name.
- container
- Container
The container properties.
The options parameters.
Returns
Promise<Container>
beginDelete(string, string, string, string, ContainersDeleteOptionalParams)
Deletes the container on the Data Box Edge/Data Box Gateway device.
function beginDelete(deviceName: string, storageAccountName: string, containerName: string, resourceGroupName: string, options?: ContainersDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- storageAccountName
-
string
The Storage Account Name
- containerName
-
string
The container name.
- resourceGroupName
-
string
The resource group name.
- options
- ContainersDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, string, ContainersDeleteOptionalParams)
Deletes the container on the Data Box Edge/Data Box Gateway device.
function beginDeleteAndWait(deviceName: string, storageAccountName: string, containerName: string, resourceGroupName: string, options?: ContainersDeleteOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- storageAccountName
-
string
The Storage Account Name
- containerName
-
string
The container name.
- resourceGroupName
-
string
The resource group name.
- options
- ContainersDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginRefresh(string, string, string, string, ContainersRefreshOptionalParams)
Refreshes the container metadata with the data from the cloud.
function beginRefresh(deviceName: string, storageAccountName: string, containerName: string, resourceGroupName: string, options?: ContainersRefreshOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- deviceName
-
string
The device name.
- storageAccountName
-
string
The Storage Account Name
- containerName
-
string
The container name.
- resourceGroupName
-
string
The resource group name.
- options
- ContainersRefreshOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginRefreshAndWait(string, string, string, string, ContainersRefreshOptionalParams)
Refreshes the container metadata with the data from the cloud.
function beginRefreshAndWait(deviceName: string, storageAccountName: string, containerName: string, resourceGroupName: string, options?: ContainersRefreshOptionalParams): Promise<void>Parameters
- deviceName
-
string
The device name.
- storageAccountName
-
string
The Storage Account Name
- containerName
-
string
The container name.
- resourceGroupName
-
string
The resource group name.
- options
- ContainersRefreshOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, ContainersGetOptionalParams)
Gets a container by name.
function get(deviceName: string, storageAccountName: string, containerName: string, resourceGroupName: string, options?: ContainersGetOptionalParams): Promise<Container>Parameters
- deviceName
-
string
The device name.
- storageAccountName
-
string
The Storage Account Name
- containerName
-
string
The container Name
- resourceGroupName
-
string
The resource group name.
- options
- ContainersGetOptionalParams
The options parameters.
Returns
Promise<Container>
listByStorageAccount(string, string, string, ContainersListByStorageAccountOptionalParams)
Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.
function listByStorageAccount(deviceName: string, storageAccountName: string, resourceGroupName: string, options?: ContainersListByStorageAccountOptionalParams): PagedAsyncIterableIterator<Container, Container[], PageSettings>Parameters
- deviceName
-
string
The device name.
- storageAccountName
-
string
The storage Account name.
- resourceGroupName
-
string
The resource group name.
The options parameters.