Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. databoxedge
  5. Share
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.databoxedge.Share

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

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

Uses Azure REST API version 2023-07-01. In version 2.x of the Azure Native provider, it used API version 2022-03-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.

Example Usage

SharePut

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var share = new AzureNative.DataBoxEdge.Share("share", new()
    {
        AccessProtocol = AzureNative.DataBoxEdge.ShareAccessProtocol.SMB,
        AzureContainerInfo = new AzureNative.DataBoxEdge.Inputs.AzureContainerInfoArgs
        {
            ContainerName = "testContainerSMB",
            DataFormat = AzureNative.DataBoxEdge.AzureContainerDataFormat.BlockBlob,
            StorageAccountCredentialId = "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
        },
        DataPolicy = AzureNative.DataBoxEdge.DataPolicy.Cloud,
        Description = "",
        DeviceName = "testedgedevice",
        MonitoringStatus = AzureNative.DataBoxEdge.MonitoringStatus.Enabled,
        Name = "smbshare",
        ResourceGroupName = "GroupForEdgeAutomation",
        ShareStatus = "Online",
        UserAccessRights = new[]
        {
            new AzureNative.DataBoxEdge.Inputs.UserAccessRightArgs
            {
                AccessType = AzureNative.DataBoxEdge.ShareAccessType.Change,
                UserId = "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
            },
        },
    });

});
Copy
package main

import (
	databoxedge "github.com/pulumi/pulumi-azure-native-sdk/databoxedge/v3"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databoxedge.NewShare(ctx, "share", &databoxedge.ShareArgs{
			AccessProtocol: pulumi.String(databoxedge.ShareAccessProtocolSMB),
			AzureContainerInfo: &databoxedge.AzureContainerInfoArgs{
				ContainerName:              pulumi.String("testContainerSMB"),
				DataFormat:                 pulumi.String(databoxedge.AzureContainerDataFormatBlockBlob),
				StorageAccountCredentialId: pulumi.String("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1"),
			},
			DataPolicy:        pulumi.String(databoxedge.DataPolicyCloud),
			Description:       pulumi.String(""),
			DeviceName:        pulumi.String("testedgedevice"),
			MonitoringStatus:  pulumi.String(databoxedge.MonitoringStatusEnabled),
			Name:              pulumi.String("smbshare"),
			ResourceGroupName: pulumi.String("GroupForEdgeAutomation"),
			ShareStatus:       pulumi.String("Online"),
			UserAccessRights: databoxedge.UserAccessRightArray{
				&databoxedge.UserAccessRightArgs{
					AccessType: pulumi.String(databoxedge.ShareAccessTypeChange),
					UserId:     pulumi.String("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.databoxedge.Share;
import com.pulumi.azurenative.databoxedge.ShareArgs;
import com.pulumi.azurenative.databoxedge.inputs.AzureContainerInfoArgs;
import com.pulumi.azurenative.databoxedge.inputs.UserAccessRightArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var share = new Share("share", ShareArgs.builder()
            .accessProtocol("SMB")
            .azureContainerInfo(AzureContainerInfoArgs.builder()
                .containerName("testContainerSMB")
                .dataFormat("BlockBlob")
                .storageAccountCredentialId("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1")
                .build())
            .dataPolicy("Cloud")
            .description("")
            .deviceName("testedgedevice")
            .monitoringStatus("Enabled")
            .name("smbshare")
            .resourceGroupName("GroupForEdgeAutomation")
            .shareStatus("Online")
            .userAccessRights(UserAccessRightArgs.builder()
                .accessType("Change")
                .userId("/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2")
                .build())
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const share = new azure_native.databoxedge.Share("share", {
    accessProtocol: azure_native.databoxedge.ShareAccessProtocol.SMB,
    azureContainerInfo: {
        containerName: "testContainerSMB",
        dataFormat: azure_native.databoxedge.AzureContainerDataFormat.BlockBlob,
        storageAccountCredentialId: "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
    },
    dataPolicy: azure_native.databoxedge.DataPolicy.Cloud,
    description: "",
    deviceName: "testedgedevice",
    monitoringStatus: azure_native.databoxedge.MonitoringStatus.Enabled,
    name: "smbshare",
    resourceGroupName: "GroupForEdgeAutomation",
    shareStatus: "Online",
    userAccessRights: [{
        accessType: azure_native.databoxedge.ShareAccessType.Change,
        userId: "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
    }],
});
Copy
import pulumi
import pulumi_azure_native as azure_native

share = azure_native.databoxedge.Share("share",
    access_protocol=azure_native.databoxedge.ShareAccessProtocol.SMB,
    azure_container_info={
        "container_name": "testContainerSMB",
        "data_format": azure_native.databoxedge.AzureContainerDataFormat.BLOCK_BLOB,
        "storage_account_credential_id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1",
    },
    data_policy=azure_native.databoxedge.DataPolicy.CLOUD,
    description="",
    device_name="testedgedevice",
    monitoring_status=azure_native.databoxedge.MonitoringStatus.ENABLED,
    name="smbshare",
    resource_group_name="GroupForEdgeAutomation",
    share_status="Online",
    user_access_rights=[{
        "access_type": azure_native.databoxedge.ShareAccessType.CHANGE,
        "user_id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2",
    }])
Copy
resources:
  share:
    type: azure-native:databoxedge:Share
    properties:
      accessProtocol: SMB
      azureContainerInfo:
        containerName: testContainerSMB
        dataFormat: BlockBlob
        storageAccountCredentialId: /subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1
      dataPolicy: Cloud
      description: ""
      deviceName: testedgedevice
      monitoringStatus: Enabled
      name: smbshare
      resourceGroupName: GroupForEdgeAutomation
      shareStatus: Online
      userAccessRights:
        - accessType: Change
          userId: /subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2
Copy

Create Share Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Share(name: string, args: ShareArgs, opts?: CustomResourceOptions);
@overload
def Share(resource_name: str,
          args: ShareArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Share(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          access_protocol: Optional[Union[str, ShareAccessProtocol]] = None,
          device_name: Optional[str] = None,
          monitoring_status: Optional[Union[str, MonitoringStatus]] = None,
          resource_group_name: Optional[str] = None,
          share_status: Optional[Union[str, ShareStatus]] = None,
          azure_container_info: Optional[AzureContainerInfoArgs] = None,
          client_access_rights: Optional[Sequence[ClientAccessRightArgs]] = None,
          data_policy: Optional[Union[str, DataPolicy]] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          refresh_details: Optional[RefreshDetailsArgs] = None,
          user_access_rights: Optional[Sequence[UserAccessRightArgs]] = None)
func NewShare(ctx *Context, name string, args ShareArgs, opts ...ResourceOption) (*Share, error)
public Share(string name, ShareArgs args, CustomResourceOptions? opts = null)
public Share(String name, ShareArgs args)
public Share(String name, ShareArgs args, CustomResourceOptions options)

type: azure-native:databoxedge:Share
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ShareArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ShareArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ShareArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ShareArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ShareArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var shareResource = new AzureNative.DataBoxEdge.Share("shareResource", new()
{
    AccessProtocol = "string",
    DeviceName = "string",
    MonitoringStatus = "string",
    ResourceGroupName = "string",
    ShareStatus = "string",
    AzureContainerInfo = new AzureNative.DataBoxEdge.Inputs.AzureContainerInfoArgs
    {
        ContainerName = "string",
        DataFormat = "string",
        StorageAccountCredentialId = "string",
    },
    ClientAccessRights = new[]
    {
        new AzureNative.DataBoxEdge.Inputs.ClientAccessRightArgs
        {
            AccessPermission = "string",
            Client = "string",
        },
    },
    DataPolicy = "string",
    Description = "string",
    Name = "string",
    RefreshDetails = new AzureNative.DataBoxEdge.Inputs.RefreshDetailsArgs
    {
        ErrorManifestFile = "string",
        InProgressRefreshJobId = "string",
        LastCompletedRefreshJobTimeInUTC = "string",
        LastJob = "string",
    },
    UserAccessRights = new[]
    {
        new AzureNative.DataBoxEdge.Inputs.UserAccessRightArgs
        {
            AccessType = "string",
            UserId = "string",
        },
    },
});
Copy
example, err := databoxedge.NewShare(ctx, "shareResource", &databoxedge.ShareArgs{
	AccessProtocol:    pulumi.String("string"),
	DeviceName:        pulumi.String("string"),
	MonitoringStatus:  pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ShareStatus:       pulumi.String("string"),
	AzureContainerInfo: &databoxedge.AzureContainerInfoArgs{
		ContainerName:              pulumi.String("string"),
		DataFormat:                 pulumi.String("string"),
		StorageAccountCredentialId: pulumi.String("string"),
	},
	ClientAccessRights: databoxedge.ClientAccessRightArray{
		&databoxedge.ClientAccessRightArgs{
			AccessPermission: pulumi.String("string"),
			Client:           pulumi.String("string"),
		},
	},
	DataPolicy:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	RefreshDetails: &databoxedge.RefreshDetailsArgs{
		ErrorManifestFile:                pulumi.String("string"),
		InProgressRefreshJobId:           pulumi.String("string"),
		LastCompletedRefreshJobTimeInUTC: pulumi.String("string"),
		LastJob:                          pulumi.String("string"),
	},
	UserAccessRights: databoxedge.UserAccessRightArray{
		&databoxedge.UserAccessRightArgs{
			AccessType: pulumi.String("string"),
			UserId:     pulumi.String("string"),
		},
	},
})
Copy
var shareResource = new Share("shareResource", ShareArgs.builder()
    .accessProtocol("string")
    .deviceName("string")
    .monitoringStatus("string")
    .resourceGroupName("string")
    .shareStatus("string")
    .azureContainerInfo(AzureContainerInfoArgs.builder()
        .containerName("string")
        .dataFormat("string")
        .storageAccountCredentialId("string")
        .build())
    .clientAccessRights(ClientAccessRightArgs.builder()
        .accessPermission("string")
        .client("string")
        .build())
    .dataPolicy("string")
    .description("string")
    .name("string")
    .refreshDetails(RefreshDetailsArgs.builder()
        .errorManifestFile("string")
        .inProgressRefreshJobId("string")
        .lastCompletedRefreshJobTimeInUTC("string")
        .lastJob("string")
        .build())
    .userAccessRights(UserAccessRightArgs.builder()
        .accessType("string")
        .userId("string")
        .build())
    .build());
Copy
share_resource = azure_native.databoxedge.Share("shareResource",
    access_protocol="string",
    device_name="string",
    monitoring_status="string",
    resource_group_name="string",
    share_status="string",
    azure_container_info={
        "container_name": "string",
        "data_format": "string",
        "storage_account_credential_id": "string",
    },
    client_access_rights=[{
        "access_permission": "string",
        "client": "string",
    }],
    data_policy="string",
    description="string",
    name="string",
    refresh_details={
        "error_manifest_file": "string",
        "in_progress_refresh_job_id": "string",
        "last_completed_refresh_job_time_in_utc": "string",
        "last_job": "string",
    },
    user_access_rights=[{
        "access_type": "string",
        "user_id": "string",
    }])
Copy
const shareResource = new azure_native.databoxedge.Share("shareResource", {
    accessProtocol: "string",
    deviceName: "string",
    monitoringStatus: "string",
    resourceGroupName: "string",
    shareStatus: "string",
    azureContainerInfo: {
        containerName: "string",
        dataFormat: "string",
        storageAccountCredentialId: "string",
    },
    clientAccessRights: [{
        accessPermission: "string",
        client: "string",
    }],
    dataPolicy: "string",
    description: "string",
    name: "string",
    refreshDetails: {
        errorManifestFile: "string",
        inProgressRefreshJobId: "string",
        lastCompletedRefreshJobTimeInUTC: "string",
        lastJob: "string",
    },
    userAccessRights: [{
        accessType: "string",
        userId: "string",
    }],
});
Copy
type: azure-native:databoxedge:Share
properties:
    accessProtocol: string
    azureContainerInfo:
        containerName: string
        dataFormat: string
        storageAccountCredentialId: string
    clientAccessRights:
        - accessPermission: string
          client: string
    dataPolicy: string
    description: string
    deviceName: string
    monitoringStatus: string
    name: string
    refreshDetails:
        errorManifestFile: string
        inProgressRefreshJobId: string
        lastCompletedRefreshJobTimeInUTC: string
        lastJob: string
    resourceGroupName: string
    shareStatus: string
    userAccessRights:
        - accessType: string
          userId: string
Copy

Share Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Share resource accepts the following input properties:

AccessProtocol This property is required. string | Pulumi.AzureNative.DataBoxEdge.ShareAccessProtocol
Access protocol to be used by the share.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
MonitoringStatus This property is required. string | Pulumi.AzureNative.DataBoxEdge.MonitoringStatus
Current monitoring status of the share.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
ShareStatus This property is required. string | Pulumi.AzureNative.DataBoxEdge.ShareStatus
Current status of the share.
AzureContainerInfo Pulumi.AzureNative.DataBoxEdge.Inputs.AzureContainerInfo
Azure container mapping for the share.
ClientAccessRights List<Pulumi.AzureNative.DataBoxEdge.Inputs.ClientAccessRight>
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
DataPolicy string | Pulumi.AzureNative.DataBoxEdge.DataPolicy
Data policy of the share.
Description string
Description for the share.
Name Changes to this property will trigger replacement. string
The share name.
RefreshDetails Pulumi.AzureNative.DataBoxEdge.Inputs.RefreshDetails
Details of the refresh job on this share.
UserAccessRights List<Pulumi.AzureNative.DataBoxEdge.Inputs.UserAccessRight>
Mapping of users and corresponding access rights on the share (required for SMB protocol).
AccessProtocol This property is required. string | ShareAccessProtocol
Access protocol to be used by the share.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
MonitoringStatus This property is required. string | MonitoringStatus
Current monitoring status of the share.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
ShareStatus This property is required. string | ShareStatus
Current status of the share.
AzureContainerInfo AzureContainerInfoArgs
Azure container mapping for the share.
ClientAccessRights []ClientAccessRightArgs
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
DataPolicy string | DataPolicy
Data policy of the share.
Description string
Description for the share.
Name Changes to this property will trigger replacement. string
The share name.
RefreshDetails RefreshDetailsArgs
Details of the refresh job on this share.
UserAccessRights []UserAccessRightArgs
Mapping of users and corresponding access rights on the share (required for SMB protocol).
accessProtocol This property is required. String | ShareAccessProtocol
Access protocol to be used by the share.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
monitoringStatus This property is required. String | MonitoringStatus
Current monitoring status of the share.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
shareStatus This property is required. String | ShareStatus
Current status of the share.
azureContainerInfo AzureContainerInfo
Azure container mapping for the share.
clientAccessRights List<ClientAccessRight>
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
dataPolicy String | DataPolicy
Data policy of the share.
description String
Description for the share.
name Changes to this property will trigger replacement. String
The share name.
refreshDetails RefreshDetails
Details of the refresh job on this share.
userAccessRights List<UserAccessRight>
Mapping of users and corresponding access rights on the share (required for SMB protocol).
accessProtocol This property is required. string | ShareAccessProtocol
Access protocol to be used by the share.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
monitoringStatus This property is required. string | MonitoringStatus
Current monitoring status of the share.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
shareStatus This property is required. string | ShareStatus
Current status of the share.
azureContainerInfo AzureContainerInfo
Azure container mapping for the share.
clientAccessRights ClientAccessRight[]
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
dataPolicy string | DataPolicy
Data policy of the share.
description string
Description for the share.
name Changes to this property will trigger replacement. string
The share name.
refreshDetails RefreshDetails
Details of the refresh job on this share.
userAccessRights UserAccessRight[]
Mapping of users and corresponding access rights on the share (required for SMB protocol).
access_protocol This property is required. str | ShareAccessProtocol
Access protocol to be used by the share.
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name.
monitoring_status This property is required. str | MonitoringStatus
Current monitoring status of the share.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
share_status This property is required. str | ShareStatus
Current status of the share.
azure_container_info AzureContainerInfoArgs
Azure container mapping for the share.
client_access_rights Sequence[ClientAccessRightArgs]
List of IP addresses and corresponding access rights on the share(required for NFS protocol).
data_policy str | DataPolicy
Data policy of the share.
description str
Description for the share.
name Changes to this property will trigger replacement. str
The share name.
refresh_details RefreshDetailsArgs
Details of the refresh job on this share.
user_access_rights Sequence[UserAccessRightArgs]
Mapping of users and corresponding access rights on the share (required for SMB protocol).
accessProtocol This property is required. String | "SMB" | "NFS"
Access protocol to be used by the share.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
monitoringStatus This property is required. String | "Enabled" | "Disabled"
Current monitoring status of the share.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
shareStatus This property is required. String | "Offline" | "Unknown" | "OK" | "Updating" | "NeedsAttention"
Current status of the share.
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 | "Cloud" | "Local"
Data policy of the share.
description String
Description for the share.
name Changes to this property will trigger replacement. String
The share name.
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).

Outputs

All input properties are implicitly available as output properties. Additionally, the Share resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
ShareMappings List<Pulumi.AzureNative.DataBoxEdge.Outputs.MountPointMapResponse>
Share mount point to the role.
SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of Share
Type string
The hierarchical type of the object.
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
ShareMappings []MountPointMapResponse
Share mount point to the role.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of Share
Type string
The hierarchical type of the object.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
shareMappings List<MountPointMapResponse>
Share mount point to the role.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of Share
type String
The hierarchical type of the object.
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
shareMappings MountPointMapResponse[]
Share mount point to the role.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of Share
type string
The hierarchical type of the object.
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
share_mappings Sequence[MountPointMapResponse]
Share mount point to the role.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of Share
type str
The hierarchical type of the object.
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
shareMappings List<Property Map>
Share mount point to the role.
systemData Property Map
Metadata pertaining to creation and last modification of Share
type String
The hierarchical type of the object.

Supporting Types

AzureContainerDataFormat
, AzureContainerDataFormatArgs

BlockBlob
BlockBlob
PageBlob
PageBlob
AzureFile
AzureFile
AzureContainerDataFormatBlockBlob
BlockBlob
AzureContainerDataFormatPageBlob
PageBlob
AzureContainerDataFormatAzureFile
AzureFile
BlockBlob
BlockBlob
PageBlob
PageBlob
AzureFile
AzureFile
BlockBlob
BlockBlob
PageBlob
PageBlob
AzureFile
AzureFile
BLOCK_BLOB
BlockBlob
PAGE_BLOB
PageBlob
AZURE_FILE
AzureFile
"BlockBlob"
BlockBlob
"PageBlob"
PageBlob
"AzureFile"
AzureFile

AzureContainerInfo
, AzureContainerInfoArgs

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 | Pulumi.AzureNative.DataBoxEdge.AzureContainerDataFormat
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 | AzureContainerDataFormat
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 | AzureContainerDataFormat
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 | AzureContainerDataFormat
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 | AzureContainerDataFormat
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 | "BlockBlob" | "PageBlob" | "AzureFile"
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.

AzureContainerInfoResponse
, AzureContainerInfoResponseArgs

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.

ClientAccessRight
, ClientAccessRightArgs

AccessPermission This property is required. string | Pulumi.AzureNative.DataBoxEdge.ClientPermissionType
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 | ClientPermissionType
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 | ClientPermissionType
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 | ClientPermissionType
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 | ClientPermissionType
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 | "NoAccess" | "ReadOnly" | "ReadWrite"
Type of access to be allowed for the client.
client This property is required. String
IP of the client.

ClientAccessRightResponse
, ClientAccessRightResponseArgs

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.

ClientPermissionType
, ClientPermissionTypeArgs

NoAccess
NoAccess
ReadOnly
ReadOnly
ReadWrite
ReadWrite
ClientPermissionTypeNoAccess
NoAccess
ClientPermissionTypeReadOnly
ReadOnly
ClientPermissionTypeReadWrite
ReadWrite
NoAccess
NoAccess
ReadOnly
ReadOnly
ReadWrite
ReadWrite
NoAccess
NoAccess
ReadOnly
ReadOnly
ReadWrite
ReadWrite
NO_ACCESS
NoAccess
READ_ONLY
ReadOnly
READ_WRITE
ReadWrite
"NoAccess"
NoAccess
"ReadOnly"
ReadOnly
"ReadWrite"
ReadWrite

DataPolicy
, DataPolicyArgs

Cloud
Cloud
Local
Local
DataPolicyCloud
Cloud
DataPolicyLocal
Local
Cloud
Cloud
Local
Local
Cloud
Cloud
Local
Local
CLOUD
Cloud
LOCAL
Local
"Cloud"
Cloud
"Local"
Local

MonitoringStatus
, MonitoringStatusArgs

Enabled
Enabled
Disabled
Disabled
MonitoringStatusEnabled
Enabled
MonitoringStatusDisabled
Disabled
Enabled
Enabled
Disabled
Disabled
Enabled
Enabled
Disabled
Disabled
ENABLED
Enabled
DISABLED
Disabled
"Enabled"
Enabled
"Disabled"
Disabled

MountPointMapResponse
, MountPointMapResponseArgs

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.

RefreshDetails
, RefreshDetailsArgs

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.

RefreshDetailsResponse
, RefreshDetailsResponseArgs

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.

ShareAccessProtocol
, ShareAccessProtocolArgs

SMB
SMB
NFS
NFS
ShareAccessProtocolSMB
SMB
ShareAccessProtocolNFS
NFS
SMB
SMB
NFS
NFS
SMB
SMB
NFS
NFS
SMB
SMB
NFS
NFS
"SMB"
SMB
"NFS"
NFS

ShareAccessType
, ShareAccessTypeArgs

Change
Change
Read
Read
Custom
Custom
ShareAccessTypeChange
Change
ShareAccessTypeRead
Read
ShareAccessTypeCustom
Custom
Change
Change
Read
Read
Custom
Custom
Change
Change
Read
Read
Custom
Custom
CHANGE
Change
READ
Read
CUSTOM
Custom
"Change"
Change
"Read"
Read
"Custom"
Custom

ShareStatus
, ShareStatusArgs

Offline
Offline
Unknown
Unknown
OK
OK
Updating
Updating
NeedsAttention
NeedsAttention
ShareStatusOffline
Offline
ShareStatusUnknown
Unknown
ShareStatusOK
OK
ShareStatusUpdating
Updating
ShareStatusNeedsAttention
NeedsAttention
Offline
Offline
Unknown
Unknown
OK
OK
Updating
Updating
NeedsAttention
NeedsAttention
Offline
Offline
Unknown
Unknown
OK
OK
Updating
Updating
NeedsAttention
NeedsAttention
OFFLINE
Offline
UNKNOWN
Unknown
OK
OK
UPDATING
Updating
NEEDS_ATTENTION
NeedsAttention
"Offline"
Offline
"Unknown"
Unknown
"OK"
OK
"Updating"
Updating
"NeedsAttention"
NeedsAttention

SystemDataResponse
, SystemDataResponseArgs

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.

UserAccessRight
, UserAccessRightArgs

AccessType This property is required. string | Pulumi.AzureNative.DataBoxEdge.ShareAccessType
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 | ShareAccessType
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 | ShareAccessType
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 | ShareAccessType
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 | ShareAccessType
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 | "Change" | "Read" | "Custom"
Type of access to be allowed for the user.
userId This property is required. String
User ID (already existing in the device).

UserAccessRightResponse
, UserAccessRightResponseArgs

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).

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:databoxedge:Share smbshare /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}
Copy

To learn more about importing existing cloud resources, see Importing resources.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native