Get-AzStorageSyncServerEndpoint

Reference

Module:: Az.StorageSync

This command lists all server endpoints within a given sync group.

Syntax

Get-AzStorageSyncServerEndpoint
   [-ResourceGroupName] <String>
   [-StorageSyncServiceName] <String>
   [-SyncGroupName] <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzStorageSyncServerEndpoint
   [-ParentObject] <PSSyncGroup>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzStorageSyncServerEndpoint
   [-ParentResourceId] <String>
   [-Name <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

This command lists all server endpoints within a given sync group. It can be used to also list the attributes of each server endpoint.

Examples

Example 1

Get-AzStorageSyncServerEndpoint -ResourceGroupName "myResourceGroup" -StorageSyncServiceName "myStorageSyncServiceName" -SyncGroupName "mySyncGroupName"

This command gets all server endpoints contained within the specified sync group. Specify -ServerEndpointName 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 server endpoint.

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

-ParentObject

StorageSyncService Object, normally passed through the parameter.

Type:	PSSyncGroup
Aliases:	SyncGroup
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:	SyncGroupId
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

-SyncGroupName

Name of the SyncGroup.

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

Inputs

PSSyncGroup

String

Outputs

PSServerEndpoint

Share via