1. Packages
  2. Azure Native
  3. API Docs
  4. databoxedge
  5. getContainer
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.databoxedge.getContainer

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Represents a container on the Data Box Edge/Gateway device.

Uses Azure REST API version 2023-07-01.

Other available API versions: 2022-03-01, 2022-04-01-preview, 2022-12-01-preview, 2023-01-01-preview, 2023-12-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native databoxedge [ApiVersion]. See the version guide for details.

Using getContainer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getContainer(args: GetContainerArgs, opts?: InvokeOptions): Promise<GetContainerResult>
function getContainerOutput(args: GetContainerOutputArgs, opts?: InvokeOptions): Output<GetContainerResult>
Copy
def get_container(container_name: Optional[str] = None,
                  device_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  storage_account_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetContainerResult
def get_container_output(container_name: Optional[pulumi.Input[str]] = None,
                  device_name: Optional[pulumi.Input[str]] = None,
                  resource_group_name: Optional[pulumi.Input[str]] = None,
                  storage_account_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetContainerResult]
Copy
func LookupContainer(ctx *Context, args *LookupContainerArgs, opts ...InvokeOption) (*LookupContainerResult, error)
func LookupContainerOutput(ctx *Context, args *LookupContainerOutputArgs, opts ...InvokeOption) LookupContainerResultOutput
Copy

> Note: This function is named LookupContainer in the Go SDK.

public static class GetContainer 
{
    public static Task<GetContainerResult> InvokeAsync(GetContainerArgs args, InvokeOptions? opts = null)
    public static Output<GetContainerResult> Invoke(GetContainerInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetContainerResult> getContainer(GetContainerArgs args, InvokeOptions options)
public static Output<GetContainerResult> getContainer(GetContainerArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:databoxedge:getContainer
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ContainerName
This property is required.
Changes to this property will trigger replacement.
string
The container Name
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
StorageAccountName
This property is required.
Changes to this property will trigger replacement.
string
The Storage Account Name
ContainerName
This property is required.
Changes to this property will trigger replacement.
string
The container Name
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
StorageAccountName
This property is required.
Changes to this property will trigger replacement.
string
The Storage Account Name
containerName
This property is required.
Changes to this property will trigger replacement.
String
The container Name
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
storageAccountName
This property is required.
Changes to this property will trigger replacement.
String
The Storage Account Name
containerName
This property is required.
Changes to this property will trigger replacement.
string
The container Name
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
storageAccountName
This property is required.
Changes to this property will trigger replacement.
string
The Storage Account Name
container_name
This property is required.
Changes to this property will trigger replacement.
str
The container Name
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
storage_account_name
This property is required.
Changes to this property will trigger replacement.
str
The Storage Account Name
containerName
This property is required.
Changes to this property will trigger replacement.
String
The container Name
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
storageAccountName
This property is required.
Changes to this property will trigger replacement.
String
The Storage Account Name

getContainer Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
ContainerStatus string
Current status of the container.
CreatedDateTime string
The UTC time when container got created.
DataFormat string
DataFormat for Container
Id string
The path ID that uniquely identifies the object.
Name string
The object name.
RefreshDetails Pulumi.AzureNative.DataBoxEdge.Outputs.RefreshDetailsResponse
Details of the refresh job on this container.
SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of Container
Type string
The hierarchical type of the object.
AzureApiVersion string
The Azure API version of the resource.
ContainerStatus string
Current status of the container.
CreatedDateTime string
The UTC time when container got created.
DataFormat string
DataFormat for Container
Id string
The path ID that uniquely identifies the object.
Name string
The object name.
RefreshDetails RefreshDetailsResponse
Details of the refresh job on this container.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of Container
Type string
The hierarchical type of the object.
azureApiVersion String
The Azure API version of the resource.
containerStatus String
Current status of the container.
createdDateTime String
The UTC time when container got created.
dataFormat String
DataFormat for Container
id String
The path ID that uniquely identifies the object.
name String
The object name.
refreshDetails RefreshDetailsResponse
Details of the refresh job on this container.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of Container
type String
The hierarchical type of the object.
azureApiVersion string
The Azure API version of the resource.
containerStatus string
Current status of the container.
createdDateTime string
The UTC time when container got created.
dataFormat string
DataFormat for Container
id string
The path ID that uniquely identifies the object.
name string
The object name.
refreshDetails RefreshDetailsResponse
Details of the refresh job on this container.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of Container
type string
The hierarchical type of the object.
azure_api_version str
The Azure API version of the resource.
container_status str
Current status of the container.
created_date_time str
The UTC time when container got created.
data_format str
DataFormat for Container
id str
The path ID that uniquely identifies the object.
name str
The object name.
refresh_details RefreshDetailsResponse
Details of the refresh job on this container.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of Container
type str
The hierarchical type of the object.
azureApiVersion String
The Azure API version of the resource.
containerStatus String
Current status of the container.
createdDateTime String
The UTC time when container got created.
dataFormat String
DataFormat for Container
id String
The path ID that uniquely identifies the object.
name String
The object name.
refreshDetails Property Map
Details of the refresh job on this container.
systemData Property Map
Metadata pertaining to creation and last modification of Container
type String
The hierarchical type of the object.

Supporting Types

RefreshDetailsResponse

ErrorManifestFile string
Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.
InProgressRefreshJobId string
If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.
LastCompletedRefreshJobTimeInUTC string
Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.
LastJob string
Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.
ErrorManifestFile string
Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.
InProgressRefreshJobId string
If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.
LastCompletedRefreshJobTimeInUTC string
Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.
LastJob string
Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.
errorManifestFile String
Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.
inProgressRefreshJobId String
If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.
lastCompletedRefreshJobTimeInUTC String
Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.
lastJob String
Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.
errorManifestFile string
Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.
inProgressRefreshJobId string
If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.
lastCompletedRefreshJobTimeInUTC string
Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.
lastJob string
Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.
error_manifest_file str
Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.
in_progress_refresh_job_id str
If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.
last_completed_refresh_job_time_in_utc str
Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.
last_job str
Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.
errorManifestFile String
Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.
inProgressRefreshJobId String
If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.
lastCompletedRefreshJobTimeInUTC String
Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.
lastJob String
Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi