Get-AzStorageSyncGroup
This command lists all sync groups within a given storage sync service.
Syntax
Get-AzStorageSyncGroup
[-ResourceGroupName] <String>
[-StorageSyncServiceName] <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzStorageSyncGroup
[-ParentObject] <PSStorageSyncService>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Get-AzStorageSyncGroup
[-ParentResourceId] <String>
[-Name <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>] Description
This command lists all sync groups within a given storage sync service. It can be used to also list the attributes of each sync group.
Examples
Example 1
Get-AzStorageSyncGroup -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName"This command gets all sync groups contained within the specified storage sync service. Specify -Name to return a specific one.
Parameters
-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: | False |
| 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 Object, normally passed through the parameter.
| 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 |
