1. Packages
  2. Azure Native
  3. API Docs
  4. databoxedge
  5. getShare
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.getShare

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 share 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 getShare

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 getShare(args: GetShareArgs, opts?: InvokeOptions): Promise<GetShareResult>
function getShareOutput(args: GetShareOutputArgs, opts?: InvokeOptions): Output<GetShareResult>
Copy
def get_share(device_name: Optional[str] = None,
              name: Optional[str] = None,
              resource_group_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetShareResult
def get_share_output(device_name: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              resource_group_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetShareResult]
Copy
func LookupShare(ctx *Context, args *LookupShareArgs, opts ...InvokeOption) (*LookupShareResult, error)
func LookupShareOutput(ctx *Context, args *LookupShareOutputArgs, opts ...InvokeOption) LookupShareResultOutput
Copy

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

public static class GetShare 
{
    public static Task<GetShareResult> InvokeAsync(GetShareArgs args, InvokeOptions? opts = null)
    public static Output<GetShareResult> Invoke(GetShareInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)
public static Output<GetShareResult> getShare(GetShareArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:databoxedge:getShare
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
Name
This property is required.
Changes to this property will trigger replacement.
string
The share name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
Name
This property is required.
Changes to this property will trigger replacement.
string
The share name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
name
This property is required.
Changes to this property will trigger replacement.
String
The share name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
name
This property is required.
Changes to this property will trigger replacement.
string
The share name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name.
name
This property is required.
Changes to this property will trigger replacement.
str
The share name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
name
This property is required.
Changes to this property will trigger replacement.
String
The share name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.

getShare Result

The following output properties are available:

AccessProtocol string
Access protocol to be used by the share.
AzureApiVersion string
The Azure API version of the resource.
Id string
The path ID that uniquely identifies the object.
MonitoringStatus string
Current monitoring status of the share.
Name string
The object name.
ShareMappings List<Pulumi.AzureNative.DataBoxEdge.Outputs.MountPointMapResponse>
Share mount point to the role.
ShareStatus string
Current status of the share.
SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of Share
Type string
The hierarchical type of the object.
AzureContainerInfo Pulumi.AzureNative.DataBoxEdge.Outputs.AzureContainerInfoResponse
Azure container mapping for the share.
ClientAccessRights List<Pulumi.AzureNative.DataBoxEdge.Outputs.ClientAccessRightResponse>
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
DataPolicy string
Data policy of the share.
Description string
Description for the share.
RefreshDetails Pulumi.AzureNative.DataBoxEdge.Outputs.RefreshDetailsResponse
Details of the refresh job on this share.
UserAccessRights List<Pulumi.AzureNative.DataBoxEdge.Outputs.UserAccessRightResponse>
Mapping of users and corresponding access rights on the share (required for SMB protocol).
AccessProtocol string
Access protocol to be used by the share.
AzureApiVersion string
The Azure API version of the resource.
Id string
The path ID that uniquely identifies the object.
MonitoringStatus string
Current monitoring status of the share.
Name string
The object name.
ShareMappings []MountPointMapResponse
Share mount point to the role.
ShareStatus string
Current status of the share.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of Share
Type string
The hierarchical type of the object.
AzureContainerInfo AzureContainerInfoResponse
Azure container mapping for the share.
ClientAccessRights []ClientAccessRightResponse
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
DataPolicy string
Data policy of the share.
Description string
Description for the share.
RefreshDetails RefreshDetailsResponse
Details of the refresh job on this share.
UserAccessRights []UserAccessRightResponse
Mapping of users and corresponding access rights on the share (required for SMB protocol).
accessProtocol String
Access protocol to be used by the share.
azureApiVersion String
The Azure API version of the resource.
id String
The path ID that uniquely identifies the object.
monitoringStatus String
Current monitoring status of the share.
name String
The object name.
shareMappings List<MountPointMapResponse>
Share mount point to the role.
shareStatus String
Current status of the share.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of Share
type String
The hierarchical type of the object.
azureContainerInfo AzureContainerInfoResponse
Azure container mapping for the share.
clientAccessRights List<ClientAccessRightResponse>
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
dataPolicy String
Data policy of the share.
description String
Description for the share.
refreshDetails RefreshDetailsResponse
Details of the refresh job on this share.
userAccessRights List<UserAccessRightResponse>
Mapping of users and corresponding access rights on the share (required for SMB protocol).
accessProtocol string
Access protocol to be used by the share.
azureApiVersion string
The Azure API version of the resource.
id string
The path ID that uniquely identifies the object.
monitoringStatus string
Current monitoring status of the share.
name string
The object name.
shareMappings MountPointMapResponse[]
Share mount point to the role.
shareStatus string
Current status of the share.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of Share
type string
The hierarchical type of the object.
azureContainerInfo AzureContainerInfoResponse
Azure container mapping for the share.
clientAccessRights ClientAccessRightResponse[]
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
dataPolicy string
Data policy of the share.
description string
Description for the share.
refreshDetails RefreshDetailsResponse
Details of the refresh job on this share.
userAccessRights UserAccessRightResponse[]
Mapping of users and corresponding access rights on the share (required for SMB protocol).
access_protocol str
Access protocol to be used by the share.
azure_api_version str
The Azure API version of the resource.
id str
The path ID that uniquely identifies the object.
monitoring_status str
Current monitoring status of the share.
name str
The object name.
share_mappings Sequence[MountPointMapResponse]
Share mount point to the role.
share_status str
Current status of the share.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of Share
type str
The hierarchical type of the object.
azure_container_info AzureContainerInfoResponse
Azure container mapping for the share.
client_access_rights Sequence[ClientAccessRightResponse]
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
data_policy str
Data policy of the share.
description str
Description for the share.
refresh_details RefreshDetailsResponse
Details of the refresh job on this share.
user_access_rights Sequence[UserAccessRightResponse]
Mapping of users and corresponding access rights on the share (required for SMB protocol).
accessProtocol String
Access protocol to be used by the share.
azureApiVersion String
The Azure API version of the resource.
id String
The path ID that uniquely identifies the object.
monitoringStatus String
Current monitoring status of the share.
name String
The object name.
shareMappings List<Property Map>
Share mount point to the role.
shareStatus String
Current status of the share.
systemData Property Map
Metadata pertaining to creation and last modification of Share
type String
The hierarchical type of the object.
azureContainerInfo Property Map
Azure container mapping for the share.
clientAccessRights List<Property Map>
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
dataPolicy String
Data policy of the share.
description String
Description for the share.
refreshDetails Property Map
Details of the refresh job on this share.
userAccessRights List<Property Map>
Mapping of users and corresponding access rights on the share (required for SMB protocol).

Supporting Types

AzureContainerInfoResponse

ContainerName This property is required. string
Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
DataFormat This property is required. string
Storage format used for the file represented by the share.
StorageAccountCredentialId This property is required. string
ID of the storage account credential used to access storage.
ContainerName This property is required. string
Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
DataFormat This property is required. string
Storage format used for the file represented by the share.
StorageAccountCredentialId This property is required. string
ID of the storage account credential used to access storage.
containerName This property is required. String
Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
dataFormat This property is required. String
Storage format used for the file represented by the share.
storageAccountCredentialId This property is required. String
ID of the storage account credential used to access storage.
containerName This property is required. string
Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
dataFormat This property is required. string
Storage format used for the file represented by the share.
storageAccountCredentialId This property is required. string
ID of the storage account credential used to access storage.
container_name This property is required. str
Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
data_format This property is required. str
Storage format used for the file represented by the share.
storage_account_credential_id This property is required. str
ID of the storage account credential used to access storage.
containerName This property is required. String
Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).
dataFormat This property is required. String
Storage format used for the file represented by the share.
storageAccountCredentialId This property is required. String
ID of the storage account credential used to access storage.

ClientAccessRightResponse

AccessPermission This property is required. string
Type of access to be allowed for the client.
Client This property is required. string
IP of the client.
AccessPermission This property is required. string
Type of access to be allowed for the client.
Client This property is required. string
IP of the client.
accessPermission This property is required. String
Type of access to be allowed for the client.
client This property is required. String
IP of the client.
accessPermission This property is required. string
Type of access to be allowed for the client.
client This property is required. string
IP of the client.
access_permission This property is required. str
Type of access to be allowed for the client.
client This property is required. str
IP of the client.
accessPermission This property is required. String
Type of access to be allowed for the client.
client This property is required. String
IP of the client.

MountPointMapResponse

MountPoint This property is required. string
Mount point for the share.
MountType This property is required. string
Mounting type.
RoleId This property is required. string
ID of the role to which share is mounted.
RoleType This property is required. string
Role type.
ShareId This property is required. string
ID of the share mounted to the role VM.
MountPoint This property is required. string
Mount point for the share.
MountType This property is required. string
Mounting type.
RoleId This property is required. string
ID of the role to which share is mounted.
RoleType This property is required. string
Role type.
ShareId This property is required. string
ID of the share mounted to the role VM.
mountPoint This property is required. String
Mount point for the share.
mountType This property is required. String
Mounting type.
roleId This property is required. String
ID of the role to which share is mounted.
roleType This property is required. String
Role type.
shareId This property is required. String
ID of the share mounted to the role VM.
mountPoint This property is required. string
Mount point for the share.
mountType This property is required. string
Mounting type.
roleId This property is required. string
ID of the role to which share is mounted.
roleType This property is required. string
Role type.
shareId This property is required. string
ID of the share mounted to the role VM.
mount_point This property is required. str
Mount point for the share.
mount_type This property is required. str
Mounting type.
role_id This property is required. str
ID of the role to which share is mounted.
role_type This property is required. str
Role type.
share_id This property is required. str
ID of the share mounted to the role VM.
mountPoint This property is required. String
Mount point for the share.
mountType This property is required. String
Mounting type.
roleId This property is required. String
ID of the role to which share is mounted.
roleType This property is required. String
Role type.
shareId This property is required. String
ID of the share mounted to the role VM.

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.

UserAccessRightResponse

AccessType This property is required. string
Type of access to be allowed for the user.
UserId This property is required. string
User ID (already existing in the device).
AccessType This property is required. string
Type of access to be allowed for the user.
UserId This property is required. string
User ID (already existing in the device).
accessType This property is required. String
Type of access to be allowed for the user.
userId This property is required. String
User ID (already existing in the device).
accessType This property is required. string
Type of access to be allowed for the user.
userId This property is required. string
User ID (already existing in the device).
access_type This property is required. str
Type of access to be allowed for the user.
user_id This property is required. str
User ID (already existing in the device).
accessType This property is required. String
Type of access to be allowed for the user.
userId This property is required. String
User ID (already existing in the device).

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