New-AzStorageSyncGroup

Reference

Module:: Az.StorageSync

This command creates a new sync group within a specified storage sync service.

Syntax

New-AzStorageSyncGroup
   [-ResourceGroupName] <String>
   [-StorageSyncServiceName] <String>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzStorageSyncGroup
   [-ParentObject] <PSStorageSyncService>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzStorageSyncGroup
   [-ParentResourceId] <String>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

This command creates a new sync group within a specified storage sync service. A sync group is used to describe a topology of locations, referred to as endpoints, that will sync any files stored within any one of the endpoints. A sync group contains cloud endpoints, which reference Azure file shares, and it also contains server endpoints which reference a specific local path on a registered server.

Examples

Example 1

New-AzStorageSyncGroup -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -Name "mySyncGroupName"

This command creates a new sync group within a specified storage sync service.

Parameters

-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

-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

-Name

Name of the SyncGroup.

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

-ParentObject

StorageSyncService Object, normally passed through the parameter.

Type:	PSStorageSyncService
Aliases:	StorageSyncService
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ParentResourceId

StorageSyncService Parent Resource Id

Type:	String
Aliases:	StorageSyncServiceId
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
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

-StorageSyncServiceName

Name of the StorageSyncService.

Type:	String
Aliases:	ParentName
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
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

PSStorageSyncService

Outputs

PSSyncGroup