New-AzStorageSyncService

This command creates a new storage sync service in a resource group.

Syntax

New-AzStorageSyncService
   [-ResourceGroupName] <String>
   [-Name] <String>
   [-Location] <String>
   [[-IncomingTrafficPolicy] <String>]
   [-Tag <Hashtable>]
   [-AsJob]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

A storage sync service is the top level resource for Azure File Sync. This command creates a new storage sync service in a resource group. We recommend to create as few storage sync services as absolutely necessary to differentiate distinct groups of servers in your organization. A storage sync service contains sync groups and also works as a target to register your servers to. A server can only be registered to a single storage sync service. If servers ever need to participate in syncing the same set of files, register them to the same storage sync service.

Examples

Example 1

New-AzStorageSyncService -ResourceGroupName "myResourceGroup" -Location "myLocation" -StorageSyncServiceName "myStorageSyncServiceName" -IncomingTrafficPolicy "AllowAllTraffic"

This command will create a storage sync service.

Parameters

-AsJob

Run cmdlet in the background.

Type:SwitchParameter
Position:Named
Default value:None
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
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
Accept pipeline input:False
Accept wildcard characters:False
-IncomingTrafficPolicy

Storage Sync Service IncomingTrafficPolicy

Type:String
Accepted values:AllowVirtualNetworksOnly, AllowAllTraffic
Position:3
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-Location

Storage Sync Service location.

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

Name of the storage sync service.

Type:String
Aliases:StorageSyncServiceName
Position:1
Default value:None
Accept pipeline input:True
Accept wildcard characters:False
-ResourceGroupName

Resource Group Name.

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

Storage Sync Service Tags.

Type:Hashtable
Aliases:Tags
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

Outputs

PSStorageSyncService