New-AzDataBoxEdgeShare

Module:

Az.DataBoxEdge

Creates a new share on the device.

Syntax

New-AzDataBoxEdgeShare
   [-ResourceGroupName] <String>
   [-DeviceName] <String>
   [-Name] <String>
   [-SMB]
   [-UserAccessRight <Hashtable[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzDataBoxEdgeShare
   [-ResourceGroupName] <String>
   [-DeviceName] <String>
   [-Name] <String>
   [-StorageAccountCredentialName] <String>
   [-CloudShare]
   -DataFormat <String>
   [-ContainerName <String>]
   [-NFS]
   [-ClientAccessRight <Hashtable[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzDataBoxEdgeShare
   [-ResourceGroupName] <String>
   [-DeviceName] <String>
   [-Name] <String>
   [-StorageAccountCredentialName] <String>
   [-CloudShare]
   -DataFormat <String>
   [-ContainerName <String>]
   [-SMB]
   [-UserAccessRight <Hashtable[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzDataBoxEdgeShare
   [-ResourceGroupName] <String>
   [-DeviceName] <String>
   [-Name] <String>
   [-NFS]
   [-ClientAccessRight <Hashtable[]>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzDataBoxEdgeShare cmdlet creates a new share on the Data Box Edge device.

Examples

Example 1

New-AzDataBoxEdgeShare -ResourceGroupName resourceGroupName -DeviceName deviceName -Name share-1 -SMB `
-StorageAccountCredentialName storageCredentialName -DataFormat PageBlob

Name       Type       DataPolicy       DataFormat       ResourceGroupName     StorageAccountName
---------- ---------- ---------------- ---------------- --------------------- -------------------
share-1    SMB        Cloud            PageBlob         resourceGroupName     storageAccountName

Parameters

-AsJob

Run cmdlet in the background

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClientAccessRight

Read/Write Access for clientIds, For ex:@(@{"ClientId"="192.168.10.10";"AccessRight"="NoAccess"}, @{"ClientId"="192.168.10.11";"AccessRight"="ReadOnly"})

Type:	Hashtable[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CloudShare

Provide existing StorageAccountCredential's Resource Name

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ContainerName

Container name (Based on the data format specified, this represents the name of Azure Files/Pageblob/Block blob)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DataFormat

Set Data Format ex: PageBlob, BlobBlob

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DeviceName

Device Name

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Resource Name

Type:	String
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-NFS

AccessProtocol in the case of creating Share

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-SMB

AccessProtocol in the case of creating Share

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StorageAccountCredentialName

Provide existing StorageAccountCredential's Resource Name

Type:	String
Position:	3
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-UserAccessRight

provide access right along with existing usernames to access SMB Share types, For ex: @(@{"Username"="user-name-1";"AccessRight"="Read"}, @{"Username"="user-name-2";"AccessRight"="Read"}, @{"Username"="user-name-3";"AccessRight"="Custom"})

Type:	Hashtable[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

PSDataBoxEdgeShare